Giter VIP home page Giter VIP logo

betterschool's Introduction

betterschool-icon-192

Hello everyone!

Do you suffer from having to log in multiple times a day to Visma Inschool? Do you experience extreme bouts of rage and frustration due to this severe issue?

Well suffer no more!

With our revoultionary technology you will never have to log in again. We have developed a web app that saves time and money. This app will show you your schedule with out wasting you precious time. The app even works offline and is availiable on both PC and Mobile.

Where can I get this magical app?

Thats easy. Just head to https://betterschool.chph.tk and simply download the website as an app.


For Developers

API documentation

The BetterSchool API is completely open and is hosted at https://api.betterschool.chph.tk/. See the documentation page for usage.


Self hosting

Both the API and the website can be self-hosted, primarily using docker, however if you want to deploy using a different method you are free to do so.

All of the docker images are hosted on a custom docker registry at docker.chph.tk if for some reason you can't access the images you will have to build them yourself using the dockerfiles in the repo.

Docker

API

Run with:

Linux:

docker run \
-p 8080:8080 \
-v betterschool-api-data:/app/data \
-e iv={INSERT RANDOM 16 CHARACTER STRING HERE} \
-e key={INSERT RANDOM 32 CHARACTER STRING HERE} \
--restart unless-stopped \
-d \
docker.chph.tk/cheesyphoenix/betterschool-api-v3:latest

One liner:

docker run -p 8080:8080 -v betterschool-api-data:/app/data -e iv={INSERT RANDOM 16 CHARACTER STRING HERE} -e key={INSERT RANDOM 32 CHARACTER STRING HERE} --restart unless-stopped -d docker.chph.tk/cheesyphoenix/betterschool-api-v3:latest

Migrating from v1 to v3

The API has recently been redesigned from the ground up, if you were already hosting a v1 API follow these steps to migrate your old data:

docker run \
-p 8080:8080 \
-v {INSERT YOUR OLD VOLUME NAME HERE}:/app/creds \
-v {INSERT YOUR NEW VOLUME NAME HERE}:/app/data \
-e iv={INSERT SAME AS OLD 16 CHARACTER STRING HERE} \
-e key={INSERT SAME AS OLD 32 CHARACTER STRING HERE} \
--restart unless-stopped \
-d \
docker.chph.tk/cheesyphoenix/betterschool-api-v3:latest

After running this, it should automatically migrate your old data. After the migration is complete, the API should work as normal. You may also remove the old volume but this is not required.

Web

Update: using a custom API now works!

Run with:

Linux:

docker run \
-p 80:80 \
--restart unless-stopped \
-e PUBLIC_API_URL={INSERT URL OF YOUR API HERE OR REMOVE THIS ARG TO USE THE OFFICIAL API} \
-d \
docker.chph.tk/cheesyphoenix/betterschool-web:-v2latest

One liner:

docker run -p 80:80 --restart unless-stopped -e PUBLIC_API_URL={INSERT URL OF YOUR API HERE OR REMOVE THIS ARG TO USE THE OFFICIAL API} -d docker.chph.tk/cheesyphoenix/betterschool-web:latest

betterschool's People

Contributors

cheesyphoenix avatar dependabot[bot] avatar velkee avatar kireobat avatar andycooldude avatar

Stargazers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.