BetterSchool

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.

API

Run with:

Linux:

docker run \
-p 8080:8080 \
-v betterschool-api-data:/src/creds \
-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:latest

One liner:

docker run -p 8080:8080 -v betterschool-api-data:/src/creds -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:latest

Migrating from v1 to v2

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

Note: using a custom api does not yet work. This is being worked on, see #54

Run with:

Linux:

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

One liner:

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