Getting Started
Prerequisites
- Docker
Install Docker by following the instructions here.
- Docker Compose
Install Docker Compose by following the instructions here.
- Git
Install Git by following the instructions here.
Installation
With Docker
-
Clone the repository:
git clone https://github.com/Devanshu-17/JTP-Technical-Project -
Navigate to the project directory:
cd JTP-Technical-Project -
Run docker-compose up:
docker-compose up --build -
Access the system
Open your web browser and navigate to
http://localhost:3000to access the application.- Backend:
http://localhost:8000 - Frontend:
http://localhost:3000
- Backend:
-
Stop the system
To stop the system, press
Ctrl + Cin the terminal and run the following command:docker-compose down
Without Docker
-
Clone the repository:
git clone https://github.com/Devanshu-17/JTP-Technical-Project -
Navigate to the project directory:
cd JTP-Technical-Project -
Install the required dependencies for the backend:
Change the directory to the backend:
cd backendInstall the required dependencies:
pip install -r requirements.txt -
Install the required dependencies for the frontend:
Change the directory to the frontend:
cd frontendInstall the required dependencies:
npm install -
Set up the MongoDB database.
Install MongoDB by following the instructions here.
-
Start the FastAPI development server:
In the backend directory, run the following command:
uvicorn app:app --reload -
In a separate terminal, start the React development server:
In the frontend directory, run the following command:
npm start -
Open your web browser and navigate to
http://localhost:3000to access the application.