Skip to content

Latest commit

 

History

History
27 lines (14 loc) · 1.46 KB

INSTALL.md

File metadata and controls

27 lines (14 loc) · 1.46 KB
Raw

Quick Start Guide

  • A docker-compose file is available (with corresponding Dockerfiles) to quickly spin up frontend and backend services along with a mongodb instance and a cloudflare tunnel (for hosting). You may use these files as is or modify them accordingly to quickly get started on the project. If for some reason you prefer to manually run the services follow the below instructions.

Backend

  • Install dependencies:

    1. Backend python requirements: pip install requirements.txt (tested using python version 3.13.0)

    2. Latex environment: textlive (for linux - apt update && apt install -y texlive)

  • Setup MongoDB database (either using mongodb atlas or locally hosted docker container), once done create a database named mydatabase and set the MONGODB_HOST_STRING env variable to the full connection string. (eg. mongodb://db:27017/mydatabase)

  • Also set the BASE_FRONTEND_URL env variable to the base url of the frontend (eg: http://localhost:3000)

  • Run the application using flask run

Frontend

  • pnpm is the preferred package manager, but npm or yarn can also be used.

  • Install dependencies using pnpm install --frozen-lockfile

  • Set the REACT_APP_BACKEND_BASE_URL to the base url of the backend (eg: http://localhost:5000), it can also be edited in the frontend/src/api/base.ts file.

  • Run the application using pnpm start