36f9a5e69b70086ac7c60939a101ffee605126ec
SleekBoard
Overview
This project consists of a Node.js backend and a React frontend, both located in their respective subdirectories.
Prerequisites
Make sure you have the following installed:
Project Structure
project-root/
│-- backend/ # Node.js backend
│-- frontend/ # React frontend
│-- README.md # This file
Backend Setup
Navigate to the backend directory
cd backend
Install dependencies
npm install
Configure Environment Variables
Create a .env file in the backend/ directory and add necessary environment variables.
PORT=5050
MONGO_URI=mongodb+srv://sleekBoard_team:cpZaj3w0lgma80BY@cluster0.egyquin.mongodb.net/?appName=Cluster0
Run the backend server
npm run start
Running in Development Mode
npm run dev
By default, the backend runs on http://localhost:5050/ (or the port specified in .env).
Frontend Setup
Navigate to the frontend directory
cd ../frontend
Install dependencies
npm install
Configure Environment Variables
Create a .env file in the frontend/ directory and add necessary environment variables.
VITE_BACKEND_URL = http://localhost:5050
Build the frontend server
npm run build
Run the frontend server in Development mode
npm run dev
By default, the frontend runs on http://localhost:5173/.
Additional Notes
- Ensure the backend is running before accessing the frontend.
- Update
.envfiles with appropriate values for production environments.
Description
Languages
JavaScript
96.4%
CSS
2.7%
HTML
0.9%