Brain Deck

A web app for creating flashcards or generating them using AI. Made using React and Django, with firebase as the datastore

Installation

For development and testing, use the development branch: git clone git@github.com:RichuSuresh/brain-deck.git and then git checkout development

Backend

1. cd /backend
2. (optional) install a python virtual environment: python -m venv env and activate it by doing cd env, then cd Scripts then activate
3. Install dependencies pip install -r requirements.txt

frontend

1. cd frontend
2. npm install

Ollama docker container

1. Download docker desktop https://www.docker.com/products/docker-desktop/

2. On docker desktop, go to Docker Hub and search for "ollama"

3. Click on "ollama/ollama"

4. Click "pull"

5. Once the image has been pulled, click on the "images" tab on the left

5.5 (optional). To use GPU passthrough, open the terminal in docker desktop (bottom right corner) and use the following command and skip steps 6, 7 and 8:

docker run -d --gpus=all -v ollama:/root/.ollama -p 11434:11434 --name ollama ollama/ollama

6. Click the play button

7. On the popup, click optional settings

8. Set the container name to ollama and the Host port to 11434

9. On the container menu, click the exec tab

10. In the console type ollama pull gemma3:4b to install the 4 billion parameter Gemma model

Starting development mode

Backend

1. cd backend

2. python manage.py runserver. This should start the backend

Frontend

1. cd frontend

2. npm run dev

3. Once the app is running, vite should present you with a link to the app in the terminal

ollama docker container

1. On docker desktop, click on the Containers tab

2. Click Start