https://github.com/ryangrieb/examgenerator
https://github.com/ryangrieb/examgenerator
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ryangrieb/examgenerator
- Owner: RyanGrieb
- Created: 2023-09-19T23:08:19.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-12-11T17:11:07.000Z (about 1 year ago)
- Last Synced: 2025-03-02T09:44:54.573Z (11 months ago)
- Language: Python
- Size: 1.91 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Exam Generator
An AI web-app that scans PDFs and other documents and generates exams/quizzes.
## Features
TBA
## Developer Software Requirements
1. Docker
2. Python3
3. Visual Studio Code
## Build Instructions
1. Install Docker, VSCode, Git, and Python3
2. Clone the repository using `git clone https://github.com/RyanGrieb/ExamGenerator.git` in the terminal
3. `cd` into the cloned repository.
4. `cd` into the `./backend` file, and run `pip install -r requirements.txt` (You might need to restart VSCode for the imports to load properly)
5. Go back to the parent directory, `cd ..`
6. Create the docker containers: `docker compose up -d` (Check if these docker images exist already)
7. Find `./data/api-keys/open_ai.txt` and enter your API key there.
8. Re-build the containers with `docker compose up -d --build`
9. To navigate to the webpage at `localhost:8000`
To re-build the all the containers after you make changes, run `docker compose up -d --build`.
**Note:** You don't need to rebuild any containers if you just modified the python files inside the `backend` directory. It's updated for you automatically.