In order to launch the database and the server, you need to provide the following environment variables in a .env file (see the sample file):

• SERVER_PORT: The port the server will listen to
• POSTGRES_DB: The name of the postgres database
• POSTGRES_USER: The name of the postgres user
• POSTGRES_PASSWORD: The database's password
• DATABASE_IP: The database's ip address
• DATABASE_PORT: The database's port
• JWT_SECRET: The secret key for the server's jwt
• TESTS_PORT: To run the unit tests
• MIGRATION_PORT: The port used for database migrations
• SES_REGION: The region configured for the AWS SES
• SES_ACCESS_KEY: The access key for the AWS SES
• SES_SECRET_ACCESS_KEY: The secret access key for the AWS SES
• SES_FROM_ADDRESS: The email address that will be used to send emails
• API_URL: An url pointing to the server host
• WEBSITE_URL: An url pointing to the website
• MATHS_KEY: The key for the mathematics library authentication

Once you provided the required environment variables, you can launch the database by running:

docker-compose up --build database

To set up or update the database, you might need to run migrations

docker-compose up --build migration-run

You can revert the migration by running:

docker-compose up migration-revert

Once you provided the required environment variables and started the database, you can launch the development server by running:

docker-compose up --build server-dev

Run the following command:

docker-compose up --build server-prod

Once the database and the server are launched, it is possible to fill the database with armies data.

Follow the instructions, and run the following command:

docker-compose up --build script_armies-data

You can find the API documentation on swagger or in the repository's documentation.

You can find the database's documentation here.

To report a bug or request a new feature, create a new issue here and use the correct template.

Before submitting an issue, please check that someone did not report a similar one.