Yadciel/taskcafe
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated Developers Guide (markdown)

Jordan Knott 2020-10-22 19:46:26 -05:00
parent 23993d2a7c
commit e71496d3fd
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
Developers-Guide.md

@ -113,3 +113,26 @@ projects, err := repository.GetProjects(ctx)
For more info on the `sqlc` query file format, take at look at [its documentation](https://sqlc.dev/).
### Running in development mode
To run `Taskcafe` in development mode, you will need a postgres database running on your local computer (Docker is a good option for this).
Then configure Taskcafe to connect to the development database using a `conf/taskcafe.toml` config file (an example can be found in `conf/taskcafe.example.toml`).
Next open up a terminal and run the API (as well as running initial schema migrations):
```
go run cmd/taskcafe/main.go web --migrate
```
Next, start the React frontend:
```
cd frontend
yarn start
```
Now you can access the interface through http://localhost:3000 while the API is served
through http://localhost:3333. The React frontend proxies all API requests to the http://localhost:3333 address.
You can find a interactive GraphQL playground at http://localhost:3333/__graphql.