This is the API boilerplate which will get you started. For any questions regarding the stack, please use our #help channel in Slack.

• Directory Layout
• Quickstart
• Usage
  • Docker
  • Bash Commands
  • Database
  • Users

./
├── /src                    # Directory for the api code, a standard express app using Postgres as database
│   ├── /config/            #
│   ├── /controllers/       #
│   ├── /helpers/           #
│   ├── /lib/               #
│   ├── /migrations/        #
│   ├── /models/            #
│   ├── /routes/            #
│   ├── /seeders/           #
│   └── server.js           #
├── .env                    # Defines environment variables for the project
├── .sequelizerc            # Defines default configuration for a database helper tool called Sequelize
├── docker-compose.yml      # Defines Docker services, networks and volumes, do not touch unless you know what you are doing
├── Dockerfile              # Defines how Docker should build a custom image for the application, do not touch unless you know what you are doing
└── README.md               # The file you are reading right now

It's best if this is started from the project root instead of inside the api repo, but if for some reason you want to work on the API independently you can run the project from this location. Here's how to do that:

Note: Only change the environment variables for POSTGRES_USER and POSTGRES_PASSWORD if working on local machine.

Copy .env.dist to .env and change the values of the environment variables if needed.

PORT=7770
ALLOW_ORIGIN=http://localhost:7771
JWT_SECRET=jwtsecretcode
POSTGRES_PORT=5432
POSTGRES_DB=api
POSTGRES_USER=user
POSTGRES_PASSWORD=root

Then run the following commands:

yarn
yarn start

Note: The database must be created and initialized after starting the app on fresh installation. See Database using PostgreSQL and Sequelize section. See Bash Commands section for Docker.

Access the app at http://localhost:7770.

Download and install the Docker Community Edition.

Note: See Bash Commands section for Docker.

Installing PostgreSQL

Mac: Getting Started with PostgreSQL on Mac OSX
Windows: Installing PostgreSQL, Creating a User, and Creating a Database

NOTE: For Mac users, you can run the PostgreSQL server on a separate terminal console by running the following command:

postgres -D /usr/local/var/postgres

Create and Initialize Database

Open a terminal console and run the following commands:

sequelize db:create
sequelize db:migrate
sequelize db:seed:all

To drop database, run the following command:

sequelize db:drop

See Bash Commands section for Docker.

On the root directory of the project, run the following commands:

Note: To view the Docker containers, open another terminal console then enter docker ps. To manage separate Docker instance for API, open another terminal console and run the commands below.

Local

Docker

• To run the commands for Docker database service, simply remove the local from the command
• The start command works only in local machine
• Used ./bin/pg/psql <database container ID or Name> to access the database console

Use the following credentials to test different API responses. Default password for all accounts is password.