CONTRIBUTING.md

Contributing

The development branch is main.
This is the default branch that all Pull Requests (PR) should be made against.

Requirements:

• Node.js version 17
• Docker version 20

Fork and set up project

Please follow instructions below to install project.

1. Fork this repository to your own GitHub account

2. Clone it to your local device

3. Create a new branch:

   git checkout -b YOUR_BRANCH_NAME

4. Install the dependencies with:

   make setup

5. Copy the environment variables:

   cp .env.example .env

   Set up your settings in .env file.

Start the project

1. Run the database in the first terminal session:

   make db-start

2. Open another terminal session

3. Apply the database migrations:

   make db-migrate

4. Populate the development database with predefined data:

   make db-seed

5. Run the web server:

   make run

The last command will start the web server on http://localhost:3000/.

Linting

To check the formatting of your code:

make lint

If you get errors, you can fix them with:

make fix

Testing

1. Run the test database in the first terminal session:

   make test-db-start

2. Run the tests suite in the second terminal session:

   make test