Skip to content

Latest commit

 

History

History
83 lines (56 loc) · 9.82 KB

README.md

File metadata and controls

83 lines (56 loc) · 9.82 KB
StudyOffline

StudyOffline

Built with ❤️ and 🍺 by Philipp, Pius and contributors

GitHub last commit (branch) GitHub issues GitHub language count Lines of code

StudyOffline is an open source tool that allows you to download the flashcards you have created on StudySmarter and study them offline.

In addition, StudyOffline is a PWA (Progressive Web App) with which you can also learn your flashcards on any smartphone or even your Tesla.

Platform support

Google Chrome Microsoft Edge Brave Safari Firefox Mobile

Linux Windows Apple Android Tesla

As you can see, we support everything. Almost everything ... A small Gallic village resists. Ω. Mozilla Firefox has unfortunately not yet managed to implement PWA support.

📱 Go online to study offline

StudyOffline StudyOffline PWA

You have two options to use StudyOffline. Either you use our free instance on app.studyoffline.de or you set up your own instance as described in the next section.

To use our instance offline, all you need to do is install the PWA (Progressive Web App) via your browser's settings.

⚒️ Setup your own StudyOffline instance

Deploy with Docker CI/CD

At the moment we do not have published StudyOffline to any container registry yet but you can easily build it by hand.

The requirement is that Docker is installed.

To do this, you just need to run

docker build https://github.com/piuswalter/StudyOffline.git#main -t studyoffline --no-cache

Now your container is built and can be started with

docker run -p 3000:3000 --name studyoffline -d studyoffline

You can access StudyOffline in your browser on https://localhost:3000/.

⚙️ Built with latest technologies

Express Angular Node.js IndexedDB

  • Express - The web framework used at the backend
  • Angular - The web framework used at the frontend
  • Node.js - The backend power
  • IndexedDB - The database to store your flashcards

📜 License

GitHub license

This project is licensed under the AGPL-3.0 License - see the LICENSE.md file for details