computer-science-flash-cards/README.md

Computer Science Flash Cards

This is a little website I've put together to allow me to easily make flash cards and quiz myself for memorization of:

• general cs knowledge
  • vocabulary
  • definitions of processes
  • powers of 2
  • design patterns
• code
  • data structures
  • algorithms
  • solving problems
  • bitwise operations

Will be able to use it on: - desktop - mobile (phone and tablet)

It uses:

• Python 3
• Flask
• SQLite

---

Important Note

I don’t recommend my flash card set.

The set included in this project (cards-jwasham.db) is not my full set, and is way too big already.

Thanks for asking for my list of 1,792 cards. But it’s too much. I even printed them out. It’s 50 pages, front and back, in tiny text. It would take about 8 hours to just read them all.

If you look at my set, you’ll just get discouraged.

My set includes a lot of obscure info from books I’ve read and machine learning knowledge.

I've added it to the project if you want it (cards-jwasham-extreme.db). You've been warned.

Please make your own set, and while you’re making them, only make cards for what you need to know. Otherwise, it gets out of hand.

Don't be like me.

How to run it on a server

1. Clone project to a directory on your web server.
2. Edit the config.txt file. Change the secret key, username and password. The username and password will be the login for your site. There is only one user - you.
3. Follow this long tutorial to get Flask running. It was way more work than it should be: https://www.digitalocean.com/community/tutorials/how-to-serve-flask-applications-with-uwsgi-and-nginx-on-ubuntu-16-04
   • wsgi.py is the entry point. It calls flash_cards.py
   • This is my systemd file /etc/systemd/system/flash_cards.service: view
     • you can see the paths where I installed it, and the name of my virtualenv directory
   • when done with tutorial:

   sudo systemctl restart flash_cards
   sudo systemctl daemon-reload
   

4. When you see a login page, you're good to go.
5. Log in.
6. Click the "General" or "Code" button and make a card!
7. When you're ready to start memorizing, click either "General" or "Code" in the top menu.

How to run with Docker

Provided by @Tinpee - tinpee.dev@gmail.com

Make sure you already installed docker

1. Clone project to any where you want and go to source folder.
2. Edit the config.txt file. Change the secret key, username and password. The username and password will be the login for your site. There is only one user - you.
3. Build image: docker build . -t cs-flash-cards
4. Run container: docker run -d -p 8000:8000 --name cs-flash-cards cs-flash-cards
5. Go your browser and type http://localhost:8000

If you already had a backup file cards.db. Run following command: Note: We don't need to rebuild image, just delete old container if you already built. docker run -d -p 8000:8000 --name cs-flash-cards -v :<path_to_folder_contains_cards_db>:/src/db cs-flash-cards. <path_to_folder_contains_cards_db>: is the full path contains cards.db. Example: /home/tinpee/cs-flash-cards/db, and cards.db is inside this folder.

For convenient, if you don't have cards.db, this container will auto copy a new one from cards-jwasham.db. So you don't need to initdb.

How to backup data ?

We just need store cards.db file, and don't need any sql command.

• If you run container with -v <folder_db>:/src/db just go to folder_db and store cards.db anywhere you want.
• Without -v flag. Type: docker cp <name_of_container>:/src/db/cards.db /path/to/save

How to restore data ?

• Delete old container (not image): docker rm cs-flash-cards
• Build a new one with -v flag: docker run -d -p 8000:8000 --name cs-flash-cards -v <path_to_folder_contains_cards_db>:/src/db cs-flash-cards
• Voila :)

Happy learning!