PrepCards

PrepCards is a Chrome extension that helps you remember things you're prone to forget by using flashcards.
Donwload on Chrome Webstore
Report Bug
Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

PrepCards is a Chrome extension that uses Flashcards to help remind you of things you're prone to forget like when learning a new language or studying a totally new topic or anything you can think of as far as it can be represneted in text.

(back to top)

Built With

• React.js
• Webpack

(back to top)

Getting Started

To setup PrepCards on your system follow the steps outlined below.

Prerequisites

For this application to work you need Node and Yarn

• npm

  npm install npm@latest -g

• Yarn Enable corepack (Node.js >=16.10)

corepack enable

Node.js <16.10

npm i -g corepack

Installation

1. Clone the repo

   git clone https://github.com/htmlHxcker/devPrep.git

2. Install NPM packages

   cd devPrep
   yarn install

3. Build an unpacked extension

      yarn run dev

4. Go to chrome://extensions in your browser and toggle developer mode, after that click "Load Unpacked" and select the generated dist folder.

(back to top)

Usage

Language Learning:

You can use this extension to build vocabulary while learning another language

Technical Interviews:

You can also use this to brush up on theoretical knowledge before technical interviews.

(back to top)

Roadmap

• Dark Mode
• Spaced Repetition System

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License.

(back to top)

Contact

Project Link: https://github.com/htmlHxcker/devPrep

(back to top)