Skip to content

fancy-flashcard/ffc

Repository files navigation

Fancy Flashcard Logo

Fancy Flashcard

Lightweight free and open-source PWA to help you learning on all your devices
Explore the docs »

Start Learning · Report Bug · Contribute

Version Number Build and Deploy status GNU GPLv2 License

Screenshots

Deck Selection Deck Selection - one deck selected Card Evaluation after finishing learning Menu Import Third Party Decks Successfully add a Deck

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).

You are also able to deploy this on your own with the help of docker. To do so you can

  1. Use the following docker commands:

    $ docker build . -t ffc
    $ docker run --name fancy-flashcard -d -p 8080:80 ffc

  2. Use the following docker-compose command:

    $ docker-compose up -d

Either way the app will be available on port 8080.

Contributing

Feel free to report bugs or ideas via Issues. Also we highly appreciate Pull Requests. Check out the Contributing Guide and the docs to get started and see how to set up Vue.js below.

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

License

Distributed under the GPL-2.0 License. See LICENSE for more information.