General Instructions

CI/CD Pipeline

Sections

1. Frontend Setup
2. Backend Setup
3. Alternative Method
4. Database Setup

Frontend Instructions

• Tech Stack

  • React
  • NextJS
  • Tailwind and MUI

• Instructions to compile:

  • Make sure you have Node installed on your machine

    • Run the following to make sure you have Node installed

      node -v
      

    • If it's not installed, download it from Node.JS

  • Make sure you're in the root directory then install required

    npm i

  • To run the server, run

    npm run dev

  • Continue from the Backend Instructions

Backend Instructions

• Tech Stack

  • Python
  • FastAPI

• Instructions to startup the FastAPI server

  • Make sure you have python installed on your machine, run:

    python --version

    It should print out your current python version, if Python is installed on your machine. If it says command not found then install Python from the official website at python.org

  • Change directory to backend using

    cd backend

  • Create a virtual environment using the command

    python -m venv venv

  • Activate the virtual environment using the command

    • For Windows

      venv\Scripts\Activate

    • For Linux and MacOS

      source venv/bin/Activate

  • Install the required dependencies using the following command

    pip install -r requirements.txt

  • After installing all the required packages, start up the fastAPI server using uvicorn

    uvicorn fastAPI:app --reload

Alternative Method

• Alternatively, there is a script to run both backend and frontend using one command

  npm run start

Total Dev Time