Getting Started (For Developers)

This guide will help you get started with the development of the project. It will start with some instructions on how to run the project locally and how to set up the development environment.

Prerequisites and Dependencies

In order to get started with the development of the project, you need to have the following tools installed on your system:

• Git (for cloning the repository)
• Docker (for running the project)
• Docker Compose (for running the project)

Additional Tools

To enable code completion and linting in your IDE, you may also need a NodeJS, yarn, and python installation.

Run the Project Locally

1. Clone the repository

git clone <repository-url>

2. Navigate to the project directory

cd <project-directory>

3. Run the following command to start the development server

docker compose up --build

4. You can now open the projects frontend at http://localhost:8003.

INFO

The --build flag is used to build the project before starting the development server.

TIP

A full overview of the project structure can be found in the Application Structure documentation.

Getting Started with Development

This section will guide you through setting up the development environment for the project. In principle the setup works similar to running the project locally, however, there are some additional steps to take.

Setting Up the Development Environment

1. Clone the repository
2. Navigate to the project directory
3. Run the following command to start the development server

docker compose up --build --watch

TIP

• the --build flag is used to build the project before starting the development server.
• the --watch flag is optional and is used to watch for changes in the codebase.

4. You can now open the projects:

   • frontend at http://localhost:8003.
   • minio console at http://localhost:9001.
   • documentation at http://localhost:4000.

5. In order to enable code completion and linting in your IDE, you may need to install additional tools.

   • For JavaScript/TypeScript, you may need to install NodeJS and yarn.
   • For Python, you may need to install python and pip.

6. You can now install the dependencies for the frontend and the backend by running the following command in the top-level directory of the project:

   yarn install

INFO

The application continues to run in the Docker container, the above command installs the dependencies on your local machine. This is necessary for code completion and linting in your IDE.

Enable Database Seeding

In order to seed the database with mock data, you can run the following command:

# This will remove the existing database
docker compose down --volumes

# enable seeding by changing SEED in the .env file to true
sed -i 's/SEED=false/SEED=true/' .env

# This will seed the database with mock data
docker compose up --build --watch