We can use the following command to start the API quickly when developing the client.
npm run dev-backend # assuming we are in the client dir
When developing the API, we can use the following command to start the services required for the API easily
npm run api-services # assuming we are in the api dir
Added documentation to reflect the above.
Types of changes
What types of changes does your code introduce?
Put an x in the boxes that apply
[ ] Bugfix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[x] Documentation Update (if none of the other choices apply)
Checklist
Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of
them, don't hesitate to ask. This is simply a reminder of what we are going to look for before merging your code.
[x] My changeset covers only what is described above (no extraneous changes)
[x] Lint and unit tests pass locally with my changes
[x] I have added tests that prove my fix is effective or that my feature works
[x] I have added necessary documentation (if appropriate)
Proposed changes
Adds some quality-of-life updates for front-end and backend development.
I used docker compose profiles to selectively start services in docker-compose
We can use the following command to start the API quickly when developing the client.
When developing the API, we can use the following command to start the services required for the API easily
Added documentation to reflect the above.
Types of changes
What types of changes does your code introduce? Put an
xin the boxes that applyChecklist
Put an
xin the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. This is simply a reminder of what we are going to look for before merging your code.