codesxcodes/braingains repository overview

⁠BrainGains

BrainGains is a local flashcard application designed to help you take notes and create flashcards during online courses, especially when learning to code. It automates the use of the Leitner system⁠. This is a system that suggests using flashcards to quiz yourself, spacing out those questions over time if you continue to answer them correctly.

⁠Features

Create and manage flashcards for different topics and sections. Practice recall with spaced repetition using the Leitner system. Supports markdown for rich text formatting and code snippets. Easy-to-use web interface built with Flask.

⁠How to Setup

Download and Install Docker Desktop⁠

1. Move to a new directory in your preferred terminal.
2. Place your flashcards.db there if you have one.
3. Run the BrainGains Container, it will mount this directory as a volume in the container:

docker run -p 5000:5000 -v .:/app/db -e DATABASE_PATH=/app/db/flashcards.db codesxcodes/braingains:latest

1. Open Your Browser and navigate to http://localhost:5000/⁠.

⁠How to Use

1. Take a Course
2. Write Flashcards
3. Quiz Daily
4. Repeat until no questions are offered

⁠Additional Information

• Braingains is designed for local learning use ONLY.
• Because we are entering code into a sqlitedb, then presenting it via the flask app, it is not advised to host this app online in any way.
• If no flashcards.db file is found, the application will create one or prompt you to have it create one.

For more details, or to run locally with Python/Flask, visit the GitHub repository⁠.