Easy Marks

Welcome to the Easy Marks repository!

Tech Stack

Frontend: React JSX

Backend: Python/Flask

Database: MongoDB

Dev/Prod Host: Heroku

Requirements

• Google account for signing into the app (currently using Google Auth)
• Azure embedding endpoint (or other emebdding API/service that uses text-embedding-ada-002 model)
• Azure summarization endpoint (or other summarization API/service)
• MongoDB account for storing users and their bookmarks
• CloudAMQP account for message queue functionality
• Cloudinary account for online image storage

Get Started

1. Clone this repository:

git clone https://github.com/labrocadabro/easy-marks.git

2. Pip install requirements.txt:

pip install -r requirements.txt

3. Install node_modules in the frontend folder:

cd frontend
npm install

4. Locate the 'example.env' file in the backend folder and replace environment variables with your own.

5. Rename 'example.env' to .env.

To Run

1. In the top level directory run Flask:

flask --app run --debug run

2. In another terminal, run the queue_worker.py script:

python queue_worker.py

3. In another terminal, change directory into the frontend folder:

cd frontend

4. Run the development environment with npm:

npm run dev

5. Sign into Easy Marks with your Google account and explore!