diff --git a/README.md b/README.md index 31346df..f2a929e 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,18 @@ 1. `npm install` 2. create `.env` file, copy values from `.example.env` -#### To run the server in local environment: +## Start options (pick one): -##### * with containerized database: +### Option 1: +#### To run the server with a containerized database: 1. `npm run docker:dev:db` (runs database in docker container) +2. `npm run migrate:latest && npm run seed` (run only once, next time you start the server - skip this step) +3. `npm run dev` +#### To run the tests under the fully containerized environment: +1. `npm run docker:test` -##### * with a system instance: +### Option 2: +#### To run the server with a system DB instance: 1. Download and install the official Postgres **v.12** package for your OS - https://www.postgresql.org/download/ 2. Using a DB observer tool (PGAdmin, Dbeaver, etc.) create a database 3. Update the `.env` with the relevant values: @@ -20,15 +26,9 @@ * `DATABASE_NAME` (name of a newly created database) * `DATABASE_USER` (default username during installation is `postgres`) * `DATABASE_ACCESS_KEY` (password to the `postgres` user, which was also set during installation) - -##### apply the migrations -1. `npm run migrate:latest && npm run seed` (run only once, next time you start the server - skip this step) - -##### start the server -1. `npm run dev` - -#### To run the tests under the fully containerized environment: -1. `npm run docker:test` +4. apply the migrations: `npm run migrate:latest && npm run seed` (run only once, next time you start the server - skip this step) +5. run the test and verify that the DB instance can be reached and everything passes: `npm run test` +6. run the server: `npm run dev` ### Troubleshooting: * __Issue__: running the `npm run docker:test` command fails with: