Skip to content

trophyso/example-study-platform

Repository files navigation


Trophy

Example Study Platform

An example flashcard study platform with gamification features powered by Trophy.
Tutorial » Trophy »

View Demo · Report Bug · Request Feature

About The Project


This is an example flashcard study platform that demostrates how to build the following gamification features in an educational setting with Trophy:

  • Multi-stage achievements with badges
  • Daily streaks
  • Automated gamified emails for achievement unlocked, and for weekly progress summaries

(back to top)

Built With

(back to top)

Getting Started

First:

npm install

Then:

npm run dev

Pre-requisites

To use the gamification features, you'll need to create a Trophy account. Follow the tutorial to get started or create an account.

Find or create your API key here and add it to your environment variables as follows:

cp .env.example .env.local
TROPHY_API_KEY='Your API key'

(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 to master

(back to top)

License

See LICENSE for more information.

(back to top)

Contact

Trophy - [email protected]

Project Link: https://github.com/trophyso/example-study-platform

Demo: https://study.examples.trophy.so

More examples: https://examples.trophy.so

(back to top)