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

  1. Clone the repository:

    git clone https://github.com/Devanshu-17/JTP-Technical-Project

  2. Navigate to the project directory:

    cd JTP-Technical-Project

  3. Run docker-compose up:

    docker-compose up --build

  4. Access the system

    Open your web browser and navigate to http://localhost:3000 to access the application.

    • Backend: http://localhost:8000
    • Frontend: http://localhost:3000
  5. Stop the system

    To stop the system, press Ctrl + C in the terminal and run the following command:

    docker-compose down

Without Docker

  1. Clone the repository:

    git clone https://github.com/Devanshu-17/JTP-Technical-Project

  2. Navigate to the project directory:

    cd JTP-Technical-Project

  3. Install the required dependencies for the backend:

    Change the directory to the backend:

    cd backend

    Install the required dependencies:

    pip install -r requirements.txt

  4. Install the required dependencies for the frontend:

    Change the directory to the frontend:

    cd frontend

    Install the required dependencies:

    npm install

  5. Set up the MongoDB database.

    Install MongoDB by following the instructions here.

  6. Start the FastAPI development server:

    In the backend directory, run the following command:

    uvicorn app:app --reload

  7. In a separate terminal, start the React development server:

    In the frontend directory, run the following command:

    npm start

  8. Open your web browser and navigate to http://localhost:3000 to access the application.