Installation

After cloning the main repository, you will need to install the dependencies for both the backend and the frontend.

Clone the Repository

First, clone the repository:

git clone <repository-url>
cd <repository-name>

Submodules

The subprojects are versioned as submodules in this repository. To download the full content, run the following command:

git submodule update --init --recursive

Backend Setup

The backend uses NestJS and Prisma as the ORM to interact with the database. Follow the steps below to set it up:

1. Install Dependencies

Navigate to the backend folder and install the dependencies:

cd backend/
npm install

2. Configure Environment Variables

Rename the .env.example file to .env.

3. Run Migrations and Seed

To ensure the database is up to date, run the migrations and seed:

npx prisma migrate dev

If the seed does not run automatically, you can execute it manually:

npx prisma db seed

Frontend Setup

The frontend uses Vite for development. Follow the steps below to set it up:

1. Install Dependencies

Navigate to the frontend folder and install the dependencies:

cd frontend/
npm install

2. Fix Dependency Issues (if necessary)

If you are using a Mac with ARM architecture (Apple Silicon), you may need to follow this procedure to fix optional dependency issues:

1. Delete the node_modules folder and the package-lock.json file.
2. Clear the npm cache using npm cache clean --force.
3. Reinstall the dependencies with npm install.

Running the Projects

Backend

To run the backend server in development mode:

cd backend
npm run start:dev

Frontend

To run the frontend server in development mode:

cd frontend
npm run dev