2020-07-10 12:31:23 +00:00
<!-- README inspired by https://github.com/othneildrew/Best - README - Template -->
2020-07-08 20:43:12 +00:00
< p align = "center" >
< a href = "https://github.com/fancy-flashcard/ffc" >
< img src = "src/assets/flash.svg" alt = "Fancy Flashcard Logo" width = "120" height = "120" >
< / a >
2020-05-18 13:35:46 +00:00
2020-07-08 20:43:12 +00:00
< h3 align = "center" > Fancy Flashcard< / h3 >
< p align = "center" >
2020-08-02 14:53:54 +00:00
Lightweight free and open-source PWA to help you learning on all your devices
2020-07-08 20:43:12 +00:00
< br / >
< a href = "docs/" > < strong > Explore the docs »< / strong > < / a >
< br / >
< br / >
2020-07-12 14:48:43 +00:00
< a href = "https://fancy-flashcard.github.io/ffc/" > Start Learning< / a >
2020-07-08 20:43:12 +00:00
·
< a href = "https://github.com/fancy-flashcard/ffc/issues" > Report Bug< / a >
·
2020-07-30 07:42:22 +00:00
< a href = "CONTRIBUTING.md" > Contribute< / a >
2020-07-08 20:43:12 +00:00
< / p >
< p align = "center" >
2020-07-30 07:42:22 +00:00
< a href = "#readme"
2020-07-21 10:32:01 +00:00
>< img src = "https://img.shields.io/badge/dynamic/json?color=informational&label=version&query=%24.version&url=https%3A%2F%2Fraw.githubusercontent.com%2Ffancy-flashcard%2Fffc%2Fmaster%2Fpackage.json" alt = "Version Number"
>< / a >
< a href = "https://github.com/fancy-flashcard/ffc/actions?query=workflow%3A%22Build+and+Deploy%22"
>< img src = "https://img.shields.io/github/workflow/status/fancy-flashcard/ffc/Build%20and%20Deploy" alt = "Build and Deploy status"
>< / a >
2020-07-30 07:42:22 +00:00
< a href = "LICENSE"
2020-07-30 20:16:02 +00:00
>< img src = "https://img.shields.io/badge/license-GNU%20GPLv2-success" alt = "GNU GPLv2 License"
2020-07-21 10:32:01 +00:00
>< / a >
2020-07-08 20:43:12 +00:00
< / p >
< / p >
2020-07-10 12:31:23 +00:00
## Screenshots
2020-05-22 14:02:09 +00:00
2020-07-14 14:48:09 +00:00
< img src = "docs/img/deck-selection.png" alt = "Deck Selection" width = "24%" / > < img src = "docs/img/deck-selection-selected.png" alt = "Deck Selection - one deck selected" width = "24%" / > < img src = "docs/img/q-and-a.png" alt = "Card" width = "24%" / > < img src = "docs/img/finish.png" alt = "Evaluation after finishing learning" width = "24%" / > < img src = "docs/img/menu.png" alt = "Menu" width = "24%" / > < img src = "docs/img/import.png" alt = "Import" width = "24%" / > < img src = "docs/img/third-party-decks.png" alt = "Third Party Decks" width = "24%" / > < img src = "docs/img/add-decks.png" alt = "Successfully add a Deck" width = "24%" / >
2020-05-20 09:20:40 +00:00
2020-07-10 12:31:23 +00:00
## Deployment
The app is build and deployed to https://fancy-flashcard.github.io/ffc on every push to master branch (via GitHub Actions and GitHub Pages).
## Contributing
Feel free to report bugs or ideas via [Issues ](issues ).
Also we highly appreciate [Pull Requests ](pulls ).
2020-08-07 16:24:50 +00:00
Check out the [Contributing Guide ](CONTRIBUTING.md ) and the [docs ](docs ) to get started and see how to set up `Vue.js` below.
2020-05-21 12:24:37 +00:00
2020-08-07 16:24:50 +00:00
| Action | Command |
| ---------------------------------------- | --------------- |
| Project setup | `npm install` |
| Compiles and hot-reloads for development | `npm run serve` |
| Compiles and minifies for production | `npm run build` |
| Lints and fixes files | `npm run lint` |
2020-05-21 12:24:37 +00:00
2020-07-10 12:31:23 +00:00
## License
2020-05-22 20:22:39 +00:00
2020-08-07 16:24:50 +00:00
Distributed under the GPL-2.0 License. See [LICENSE ](LICENSE ) for more information.
