Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Pritesh-Patel committed Sep 10, 2019
1 parent afc46a9 commit 8ac6421
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Expand Up @@ -7,11 +7,11 @@ Sprout intends to be a multi-language service generator. The intention is to cre
Based on specified config it will generate:
* Proto files [Done]
* Proto libraries [Done]
* GraphQL files [In progress]
* GraphQL libraries [In progress]
* Http grpc gateway [Later]
* GraphQL files [Later]
* GraphQL libraries [Later]
* Http grpc gateway [In progress]
* grpc web [Later]
* Layout [In progress]
* Layout [Done for go]
* Kubernetes manifests [In progress]

It will also live with your project, when you add a new service to the config it will generate everything needed for that new service.
Expand All @@ -20,21 +20,21 @@ It will also live with your project, when you add a new service to the config it

The generation will create 2 folders.

* A rep for the IDL's, this folder will also contain generated artifacts from the IDL under 'gen'
* A repo for the IDL's, this folder will also contain generated artifacts from the IDL under 'gen'
* A repo that implements the interfaces of the generated artifacts

`NOTE: It only creates the folders for these repos, you will still need to create the git repos on your respected platform. Aswell as initialise each folder as a git repo and push when there have been changes. (if there is a strong desire we can look at how to make this process easier.)`

## The development cycle

1) Make folder and within that folder execute `sprout create [PROJECT_NAME]`
2) A folder will be created and within that update the `sprout.yml` and then run `sprout generate -l=[LANGUAGE OF CHOICE]`
1) Make folder with the name of your project and within that folder execute `sprout create [PROJECT_NAME]`
2) A folder will be created and within that update the `sprout.yml` and then run `sprout generate -l=[LANGUAGE OF CHOICE] eg. go`
3) Move back to the root folder and you will see that there is now an idl folder created.
4) Modify the the protobuf services generated with your desired methods
5) Either run `prototool generate` or return to the application folder and re run `sprout generate`
6) Push up the IDL repo
6) Implement these methods on the main application repo
7) When you feel the need to add more services add them to the sprout config and re-run `sprout generate` and repeat steps 4 - 6.
7) Push up the IDL repo & remove the replace function in the go.mod in the implementation project (this will swap it over to using the live IDL pushed up to git instead of your local one)
8) When you feel the need to add more services add them to the sprout config and re-run `sprout generate` and repeat steps 4 - 7.

## Dependencies

Expand Down

0 comments on commit 8ac6421

Please sign in to comment.