durvalm / tutorproject

Tutoring platform

Run Locally

Clone the project

  git clone https://github.com/sernanic/tutorProject.git

Frontend Instructions

Go to the frontend of the project directory

  cd tutorProject/frontend

Install dependencies

  npm install

Backend Instructions

Go to the backend of the project directory

  cd tutorProject/backend

Create a Python virtual environment

  python3 -m venv venv

Enter in the virtual environment (mac)

  source venv/bin/activate

obs: Before the next step, check if your python interpreter is set to ./backend/venv/bin/python3

Install dependencies

Installation might change based on OS

Run the following command in the terminal

  pip install -r requirements.txt

Database Instructions

• Download Mysql

• Download Mysql Workbench and open it

• Under MySQL Connections, if there is a local instance If there is, click on it

• If not, press the + button to create one and set username and password

• Back to the project, go to the .env.sample file of the backend, rename it to .env

• Inside the .env file, adjust the DATABASE_URL according to your mysql username and password

  DATABASE_URL=mysql+pymysql://user:pass!@localhost:3306/tutorProject
  //example:
  DATABASE_URL=mysql+pymysql://NicolasSerna:Sernanic123!@localhost:3306/tutorProject

• Also in the .env set a SECRET_KEY, it can be any string, but for security, use a secure token

• run migrations so you have the models in your database (make sure you are in the backend folder)

  alembic revision --autogenerate -m 'test'

  alembig upgrade head

Start the frontend / backend servers

backend

cd tutorProject/backend/app

uvicorn main:app --reload

one a separate command line window

frontend

cd tutorProject/frontend

npm run start