Project Installation Guide

This guide explains how to set up and run the backend and frontend of the project using Docker and shell scripts.

---

Step 1: Create Environment Files

Run the setup.sh script to create .env files in both the client and server folders if they don't already exist. This will add the necessary environment variables for local development.

./setup.sh

⸻

Step 2: Ensure Docker Is Running

Docker is required to run the services. Check if Docker is running with:

sudo systemctl status docker

If Docker is not running, start it with:

sudo systemctl start docker

Note:

• On macOS or Windows, make sure Docker Desktop is running.
• You may need administrative privileges to start Docker.

⸻

Step 3: Install Dependencies

Before running the app, make sure the install.sh script is executable and run it:

chmod +x install.sh
./install.sh

This script installs all necessary dependencies for both backend and frontend.

⸻

Additional Notes

• Ensure you have a bash shell to run .sh scripts.
• You can modify the .env files later if you need to change environment settings.
• If you face permission issues, try running commands with sudo.
• The MongoDB database should be hosted locally, and both the backend and frontend run on localhost, as configured in the setup.sh script.
• Any required code changes can be found within the respective folders, if needed.

⸻