Getting Started

Follow the steps below to get everything up and running smoothly.

Environment Setup

I have prepared .env and .env.local requirements files for each part of our project. Please locate these files in the following directories and configure them as needed:

• App (Frontend)
  • Directory: client
• Server (Backend)
  • Directory: server

Review the .env/.env.local requirements.txt files within these directories to understand the necessary parameters. Then, create or update your .env or .env.local files accordingly (.env in server / .env.local in client).

Project Installation

Once your environment is configured, it's time to install the dependencies and start up each part of the project.

Before proceeding, make sure to search throughout the codebase and replace the following placeholder variables with your information:

• [YOUR_APP_NAME]: The name of your application.
• [LOWERCASED_APP_NAME]: The name of your application in lowercase.
• [YOUR_DOMAIN]: Your application's domain name. ([YOUR_DOMAIN].com)
• [YOUR_BUCKET_NAME]: The name of your S3 bucket or other storage bucket.

/server/src/utils/bull.ts:

• [REDIS_PORT]: The port of your redis server.
• [REDIS_HOST]: The host of your redis server.
• [REDIS_USERNAME]: The username of your redis server.
• [REDIS_PASSWORD]: The password of your redis server.

Frontend (App)

Navigate to the client directory and run the following commands:

1. Install dependencies:

npm i

2. Start the development server:

npm run dev

Backend (Server)

Make sure you have Docker and Docker Compose installed. Navigate to the server directory and run the following commands:

1. Build and start the containers:

docker-compose up --build -d

2. Show logs:

docker-compose logs -f