Developer: David Lee
Table of Contents
About | Features | Installation | Contact
Demo the live site!CardMe is a flashcard / study application that allows users to create and maintain sets of flashcards or use sets created by other users. Users can like and favorite specific sets in order to refer to them at a later time. Features include a search bar that can filter particular subjects, sets, cards, and other users. Users may also participate in a randomized multiple-choice quiz specific to the contents of each set. Enjoy!
- Navigate through all the sets created by CardMe users
- Like and favorite sets in order to build a sets credibility or save it for future reference
- Create a set and its corresponding cards (pin to an existing subject or create a new one)
- Use the search bar to query and filter the existing database for related sets, subjects, cards, and users
- Quiz yourself using the randomized, multiple-choice quiz specific to each set and constructed with the contents of its flashcards
-
Clone this repository
git clone https://github.com/dyclee/flashcardApp.git
-
Install dependencies
pipenv install --dev -r dev-requirements.txt && pipenv install -r requirements.txt
-
Create
.env
file (Example is provided within repo) -
Set up Postgres database based on
.env
credentials -
Enter pipenv environment, migrate associated database, and run the flask application
pipenv shell
flask db upgrade
python seeder.py
flask run
-
To run the application in development, run
npm start
within thereact-app
directory
(Full-stack developer, Open to work)