This project consists of a backend server and a frontend UI application. The backend runs on Node.js and Express, while the frontend is built using React.
- Node.js installed on your machine
- npm (Node Package Manager)
-
Navigate to the Server Directory:
cd /Server -
Install Dependencies:
npm install
-
Configure Environment Variables:
- Go to the
ENV-EXAMPLE.txtfile. - Add your secret keys and rename the file to
.env.
- Go to the
-
Install Nodemon Globally (Optional but Recommended):
npm install -g nodemon
-
Start the Server:
npm run start
The server will be up and running at
http://localhost:3000.
-
Navigate to the UI Directory:
cd /UI -
Install Dependencies:
npm install
-
Start the UI Application:
npm run start
-
Verify Backend URL Configuration:
- Open the
config.tsfile we can also do the same in.envas well - Ensure that the backend URL is correctly configured to point to
http://localhost:3000.
- Open the
- The backend server will be accessible at
http://localhost:3000. - The frontend application will typically run on
http://localhost:5173or another port if specified in your configuration.
- If you encounter any issues with dependencies, try deleting the
node_modulesfolder and thepackage-lock.jsonfile, then runnpm installagain. - Ensure that your
.envfile is correctly configured with all necessary environment variables.
This README provides a clear and structured guide for setting up and running the project, ensuring that developers can quickly get started with the backend and frontend components.