Setting up your development environment#

Forking the repository#

Ready to contribute? Here’s how to set up your development environment for CHORAS. We always recommend creating a fork of the repository you would like to contribute to. This allows you to freely develop and test your changes without affecting the main repository until you’re ready to submit a pull request.

Fork the repository you want to contribute to (e.g., choras-org/frontend-v2). Please make sure that you enable giving maintainers access to your fork, so we can help you if you run into issues.
Clone your forked main repository to your local machine:
```
git clone https://github.com/<your-username>/CHORAS
cd CHORAS
```
If you only want to contribute to the frontend/backend, you can instead clone the original repository.
Navigate into the CHORAS directory and initialize the three (frontend-v2, backend, and simulation-backend) submodules:
```
cd CHORAS
git submodule update --init --recursive
```
Update the remote URL of the submodules to point to your forked repositories. For example, for the frontend submodule:
```
cd frontend-v2
git remote set-url origin https://github.com/<your-username>/frontend-v2
```
If you prefer to use SSH instead of HTTPS, the command would be:
```
git remote set-url origin git@github.com:<your-username>/frontend-v2.git
```
Optionally, you can also set up the upstream remote to keep your fork in sync with the original repository:
```
git remote add upstream https://github.com/choras-org/frontend-v2
```
Finally, create a new branch for your changes:
```
git checkout -b my-feature-branch
```

Quickstart developing#

To set up the development environment for the frontend, follow these steps:

Install node.js on your machine.
Once installed, run the following commands while navigating to the folder where you want the CHORAS frontend to live:
```
git clone -b dev https://github.com/choras-org/frontend-v2.git
cd frontend-v2
npm install
npm run dev
```
Go to http://localhost:5173/ in your favourite browser and the user interface should be visible.
If the projects are not loaded correctly or if you have trouble creating a new project, this means that you still need to get the backend up and running. Follow the instructions here.