Skip to main content

Getting Started

This section explains the steps to set up your development environment and start the application.

Prerequisites​

  • Node.js:
    The project includes a .nvmrc file. We assume that you have nvm installed so that you can automatically use the correct Node version.
  • Docker & Docker Compose:
    Ensure that Docker and Docker Compose are installed and properly configured.
  • Git LFS:
    The project uses Git submodules with Git LFS. Make sure Git LFS is installed on your system. On macOS, you can install it using: 
    brew install git-lfs

Step-by-Step Guide​

  1. Install Dependencies​

    Run the following command to install all required Node packages:

    npm install

    This step downloads all the dependencies needed for the project.

  2. (Optional) Update Git Submodules​

    The project uses git submodules along with Git LFS. If you haven't updated them recently, run:

    git submodule update --init --recursive

    This command will also fetch the Git LFS files automatically, provided Git LFS is installed. If you experience any issues, navigate to the respective submodule directory and run:

    git lfs pull

  3. Start Docker Containers​

    Launch the Docker containers in detached mode:

    docker compose up -d

    Note:

    • The docker-compose.yml currently starts two services:
      • MongoDB
      • Redis
    • Initial passwords are set and will also appear in the .env.development.local file.
    • Volumes are created under ./data to persist local data.
    • Ports starting from 64000 are used to avoid conflicts with other projects.

  4. Configure Environment Variables​

    Copy the default environment variables to create a local configuration file:

    cp .env.default .env.development.local

    This file provides an out-of-the-box solution. You can modify the settings here during development as needed.

  5. Start the Application​

    Launch the application with:

    npm start

    This will initialize the application, making it ready for use.

Troubleshooting Tips​

(This section is currently empty as we have not encountered issues yet. Future updates will include detailed troubleshooting tips and solutions for common problems.)

Following these steps should allow you to successfully set up your development environment and start the application.