Jonathan Bernard
3844e97c48
- Re-organized and documented make targets. - Parameterized the make targets to more cleanly support multiple development scenarios. - Documented the different development scenarios in a README. - Standardized the host port used when running locally. - Updated DEV and PROD database config files to match current practice. - Renamed `personal_measure_api.config.prod.json` to `personal_measure_api.config.docker.json` to more accurately reflect that this is the config used when building the docker image (regardless of which env it ends up in).
31 lines
762 B
Markdown
31 lines
762 B
Markdown
## Local Development
|
|
|
|
Examples of different local development & testing scenarios:
|
|
|
|
- Bare-metal API server, local Postgres container
|
|
|
|
make start-postgres
|
|
make serve
|
|
|
|
- Bare-metal API server, different Postgres server
|
|
|
|
DB_CONN_STRING="host=<db-hostname> user=pmapi password=<pwd>" make serve
|
|
|
|
- Docker API Server, local Postgres container
|
|
|
|
make start-postgres
|
|
VERSION=0.X.0-alpha make serve-docker
|
|
|
|
- Docker API server, different Postgres server
|
|
|
|
DB_CONN_STRING="host=<db-hostname> user=pmapi password=<pwd>" \
|
|
VERSION=0.X.0-alpha \
|
|
make serve-docker
|
|
|
|
All of the available `make` targets are documented inline; see the
|
|
[Makefile](./Makefile) for more details.
|
|
|
|
### Using the API CLI wrapper
|
|
|
|
The API CLI wrapper
|