Relay

Requirements

Make sure you have the following installed:

• Node.js
• npm
• Git

You can verify your installations with:

node --version
npm --version
git --version

Installation

Follow the steps below to set up Relay locally.

1. Clone the repository

git clone https://github.com/emps725/Relay.git
cd Relay

2. Install Frontend Dependencies

Navigate to the frontend directory:

cd frontend
npm install

3. Install Backend Dependencies

Go back to the project root and navigate to the backend directory:

cd ../backend
npm install

4. Environment Variables

The project requires environment variables in the backend folder, create the required .env file according to the .env.example provided.

5. Run the Project

Start the frontend and backend using their respective development commands.

Frontend:

cd frontend
npm run dev

Backend:

Open another terminal:

cd backend
npm run dev

Project Structure

Relay/
├── frontend/       # Frontend application
├── backend/        # Backend application
└── README.md

Fresh Setup Summary

git clone https://github.com/emps725/Relay.git
cd Relay

cd frontend
npm install

cd ../backend
npm install

After installing the dependencies and configuring the required environment variables, start the frontend and backend development servers.