Getting Started using CHORAS#

Downloading CHORAS#

In your terminal run the following commands to clone the CHORAS repository and initialize the submodules:

git clone https://github.com/choras-org/CHORAS.git
cd CHORAS

This repository includes three submodules that need to be initialized:

  • frontend-v2

  • backend

  • simulation-backend

This can be achieved by executing the following command within the CHORAS repository:

git submodule update --init --recursive

Building CHORAS#

Building all components of CHORAS will require at least 15 GB of free disk space. Make sure you have sufficient space before proceeding.

From the root directory of the CHORAS repository (see the previous section):

Note

Make sure Docker Desktop is running.

  1. In the terminal, run:

sh CHORAS_BUILD.sh

.\CHORAS_BUILD.bat

This script builds and starts all required containers.

  1. Once the build completes, open your browser and go to: http://localhost:5173/

If you face any issues during the build process, please refer to the Frequently Asked Questions section for troubleshooting tips.

You should now see the CHORAS user interface.

Note

Please refer to the Starting CHORAS section for instructions on how to start CHORAS in the future without rebuilding it.