DeckTrack

Open-source Spaced Repetition System.

View Demo · Report Bug · Request Feature

Note: this repository is now being wired into the TutPro Supabase stack. For the current local setup flow, use LOCAL_SETUP.md.

About The Project

Built With

Frontend

• React.js
• GraphQL
• ApolloClient
• CSS Modules
• React Router
• react-toastify
• Day.js

Backend

• Node.js
• ApolloServer
• Prisma ORM
• JWT

---

Features

• Flashcard creation
• Organizing flashcards in decks
• Automatic review scheduling based on recall performance
• User registration/login

Upcoming

• Different learning modes (quizz, match pairs etc.)

---

Getting started

The simplest way to get your own instance up and running is by using Docker.

1. Clone the project git clone https://github.com/sebwojtasik/flashy.git.
2. Create your own .env files by editing .env.template in the main directory, /server and /client folders.
3. Run docker-compose up to build the images and start the containers.

---

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

---

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)