8000 GitHub - dyclee/flashcardApp
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

dyclee/flashcardApp

Repository files navigation

JavaScript React CSS3 Docker Python Flask SQLAlchemy PostgreSQL

CardMe

A Flashcard and Study Application

Developer: David Lee

login

Table of Contents

About | Features | Installation | Contact

Demo the live site!

About CardMe

navigate homepage gif

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!


Database Schema DB schema

Features

navigate homepage gif

  • 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 set gif

  • 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

quiz gif

Installation

  1. Clone this repository

    git clone https://github.com/dyclee/flashcardApp.git
  2. Install dependencies

    pipenv install --dev -r dev-requirements.txt && pipenv install -r requirements.txt
  3. Create .env file (Example is provided within repo)

  4. Set up Postgres database based on .env credentials

  5. Enter pipenv environment, migrate associated database, and run the flask application

    pipenv shell
    flask db upgrade
    python seeder.py
    flask run
  6. To run the application in development, run npm start within the react-app directory


Contact

Please feel free to reach out!

David Lee

(Full-stack developer, Open to work)

Resume PDF David Lee's email LinkedIn AngelList GitHub dyclee

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published
0