ffc/README.md

<!-- README inspired by https://github.com/othneildrew/Best-README-Template -->

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

  <h3 align="center">Fancy Flashcard</h3>

  <p align="center">
    Lightweight open-source PWA to help you learning on all your devices
    <br />
    <a href="docs/"><strong>Explore the docs »</strong></a>
    <br />
    <br />
    <a href="https://fancy-flashcard.github.io/ffc/">Open PWA</a>
    ·
    <a href="https://github.com/fancy-flashcard/ffc/issues">Report Bug</a>
    ·
    <a href="https://github.com/fancy-flashcard/ffc/pulls">Contribute</a>
  </p>

  <p align="center">
    <a href="https://github.com/fancy-flashcard/ffc">
      <img src="https://github.com/dhbw-ffc/ffc/workflows/Build%20and%20Deploy/badge.svg" alt="Build and Deploy status">
    </a>
  </p>
</p>

# Fancy Flashcard <!-- omit in toc -->

- [Screenshots](#screenshots)
- [Deployment](#deployment)
- [Contributing](#contributing)
  - [Project setup](#project-setup)
  - [Compiles and hot-reloads for development](#compiles-and-hot-reloads-for-development)
  - [Compiles and minifies for production](#compiles-and-minifies-for-production)
  - [Lints and fixes files](#lints-and-fixes-files)
- [License](#license)

## Screenshots

<img src="docs/img/deck-selection.png" alt="Deck Selection" width="30%" /> <img src="docs/img/deck-selection-selected.png" alt="Deck Selection - one deck selected" width="30%" /> <img src="docs/img/q-and-a.png" alt="Card" width="30%" /> <img src="docs/img/finish.png" alt="Evaluation after finishing learning" width="30%" /> <img src="docs/img/menu.png" alt="Menu" width="30%" /> <img src="docs/img/import.png" alt="Import" width="30%" />

## 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).
Check out the [docs](docs) to get started and see how to set up `Vue.js` below.

### 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 MIT License. See [LICENSE](LICENSE) for more information.