The API can be run locally from the workspace root rather than the project root - IE /newsletters-nx/ not /newsletters-nx/apps/newsletters-api/
From the workspace root: npm run dev will run the API on http://localhost:3000/
On the default configuration, the API serves a the UI on its index page, so http://localhost:3000/ will display the UI, but the API response can be accessed at their path, e.g. http://localhost:3000/api/newsletters
Local environment variables can be set by:
- Copying apps/newsletters-api/env.local.example.txt and rename it .env.local (This file will be .gitignored), or
- setting them on the command line, eg
NEWSLETTERS_UI_SERVE=false npm run dev
By default, the local application uses an in-memory storage system (so data you enter will not persist when the application restarts). To use an S3 bucket for storage instead, you will need to set the environment variables for the s3 parameters. You will need credentials for the right AWS account (IE the account the S3 bucket it in) from Janus, for the API to be able to access the bucket and read/write files.
⚠ Avoid committing the names of S3 bucket into the repository. .env.local is gitignored. You should not need to enter them in any other files.
⚠☣☢ Do not give your local instance access to the PROD S3 bucket containing the live data! ⚠☣☢