Skip to content

Latest commit

 

History

History
144 lines (111 loc) · 5.22 KB

README.md

File metadata and controls

144 lines (111 loc) · 5.22 KB
Raw

Flipcards

Fun and Simple Flashcards
Explore the docs »

View Demo · Report Bug · Request Feature

GitHub contributors GitHub license GitHub issues GitHub last commit GitHub Repo stars

Give a ⭐️ if our project helped or interests you!

Table of Contents
  1. About Flipcards
  2. Getting Started
  3. Contributing Guide
  4. License

About Flipcards

Flipcards is a simple flashcard game to train your computer science algorithm muscles. Start recognising common problem solving patterns today as the first step to conquering those leetcode problems!

This is an open source project and the purpose of this project is not to be a fully featured app. It creates the foundation for a fun flashcard game based on the below system design. Feel free to fork this repo and make it your own, or create a PR to become a contributor to Flipcards.

gif

systems_design

Features

  • Add leetcode questions to the relational database
  • Display and navigate through the question collection
  • Light and Dark Mode
  • Run tests in development mode
  • Flip the flashcard to see the answer

Built with

(back to top)

Getting Started

The following instructions are to get started with Flipcard in development mode:

  1. Clone this repo git clone https://github.com/crumblepie/flipcards
  2. Install the dependencies npm install
  3. Run script for development mode npm start-dev. Navigate to localhost:8080 in your browser if the port does not automatically open.
  4. Build a production build npm run build-prod
  5. Build a development build npm run build-dev
  6. Run unit tests npm run test

Use your own database with Flipcards

  1. Replace the postgreSQL URI string in model.js with your own
  2. Create a new table using a statement such as the below:
CREATE TABLE Algos (
  "_id" serial AUTO INCREMENT PRIMARY KEY,
  "name" varchar NOT NULL,
  "difficulty" varchar NOT NULL,
  "prompt" text NOT NULL,
  "solution" text NOT NULL,
  "pattern" text NOT NULL
)

Add new data to the database

New questions can be added to our relational database with a sql command following this format:

INSERT INTO "public"."Algos"
VALUES ('9', 'Max Consecutive Ones III', 'Medium',
'Given an array A of 0s and 1s, we may change up to K values from 0 to 1. Return the length of the longest (contiguous) subarray that contains only 1s.', 'Solution to Max Consecutive Ones III', 'Sliding Window');

Contributors

Rain Hsu | Eugene Lee | Jae Hyun Ha | David Lopez

Contributing Guide

Contributions are welcome and greatly appreciated.

If you have a suggestion of how to make Flipcart better, please follow the below instructions or open an issue with the tag "enhancement".

  1. Fork this repo
  2. Create your Feature Branch (git checkout -b yourgithubhandle/feature-name)
  3. Commit your Changes (git commit -m 'Add some feature')
  4. Create and push to your remote branch (git push origin yourgithubhandle/feature-name)
  5. Open a Pull Request to dev branch

(back to top)

License

Licensed under MIT License.