maoaii/flashcard_app

Janki

A Flashcard app for learning japanese Kanji and Vocabulary - inspired by Anki.

Report Bug · Request Feature

Table of Contents

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

About The Project

(back to top)

Built With

• 
• 

(back to top)

Getting Started

To list out the available commands, use:

make

Setup

1. Clone the repo

   git clone https://github.com/Maoaii/FlashCard_App.git

2. Setup project dependencies

   make setup

3. Run the project

   make run

(back to top)

Usage

• Home Screen - There are two pages that you can access from here plus the quit button.

• Reviews Screen - Here, you'll answer to the cards that are up for review. For each card, there will be a 'meaning' and a 'reading' review. If and only if you get both right, the card will have its' level upgraded - downgraded otherwise.

• Add cards Screen - Add new cards to your deck here! You can add 'Kanji' or 'Vocabulary' cards and give them your custom title, reading and meaning.

(back to top)

Roadmap

• Counter for number of reviews currently available (both at the home screen and the review screen).
• A new tab that allows the user to see the cards in the deck.
• A level for those cards that the user really knows so they don't get stuck on level 5.
  • Also, a tab to review those cards separately.

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. See LICENSE.txt for more information.

(back to top)

Contact

Lucas Girotto - [email protected]

Project Link: https://github.com/Maoaii/FlashCard_App

(back to top)

Acknowledgments

• Readme template - A huge thank you to othneildrew for the awesome README template that I used on this project!

(back to top)

flashcard_app's Issues

Update card's review date when the day passes

Create a counter for the number of reviews available

Create a tab to view all the cards in the deck