You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-4Lines changed: 6 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,15 +32,17 @@ The generation will create project folder, within this there will be your implem
32
32
3) You will see that there is now an idl folder created.
33
33
4) Within the idl folder modify the the protobuf services generated with your desired methods
34
34
5) Go up to the parent directory and re run `commit0 generate -l=[LANGUAGE OF CHOICE]`
35
-
6) You will now see a `servers` folder navigate to your service folder within that directory and implement the methods generated for it
35
+
6) You will now see a `server` folder navigate to your service folder within that directory and implement the methods generated for it
36
36
7) Once you have tested your implementation and are happy with it return to the idl repo push that directory up to git
37
37
8) Return to the parent directory and check the depency file, for go it will be the go.mod file remove the lines that point it to your local directory, this will now point it to the version on git that was pushed up previously
38
38
10) Test and push up your implementation!
39
39
9) When you feel the need to add more services add them to the commit0 config and re-run `commit0 generate` and repeat steps 4 - 7.
40
40
41
41
## Usage & installation
42
42
43
-
As there alot of dependencies it will be easier to use this tool within the provided image, clone the repo and then run `make build-docker-local`. The best way then to use this is to alias `docker run -v "$(pwd):/project" --user $(id -u):$(id -g) commit0:v0` as commit0 from then you can use the CLI as if it was installed as usual on your machine.
43
+
As there alot of dependencies it will be easier to use this tool within the provided image, clone the repo and then run `make build-docker-local`.
44
+
The best way then to use this is to add an alias, then you can use the CLI as if it was installed as usual on your machine:
45
+
`alias commit0='docker run -v "$(pwd):/project" commit0:v0'`
44
46
45
47
## Dependencies
46
48
@@ -49,11 +51,11 @@ In order to use this you need ensure you have these installed.
49
51
* protoc-gen-go [Go]
50
52
* protoc-gen-web [gRPC Web]
51
53
* protoc-gen-gateway [Http]
52
-
*prooc-gen-swagger [Swagger]
54
+
*protoc-gen-swagger [Swagger]
53
55
54
56
## Building locally
55
57
56
58
As the templates are embeded into the binary you will need to ensure packr2 is installed.
0 commit comments