Invictus Bier Systeem is het websysteem voor O.D.D. Invictus.

Ontwikkelen

Om te beginnen met ontwikkelen moet je eerst de repository clonen met

git clone git@github.com:ODDInvictus/ibs3.git

als dit niet lukt moet je even je SSH keys instellen op GitHub

Daarna moet je een .env maken, dit kan door de .env.example te kopieren en te hernoemen. Deze moet je nog wel even invullen. Zie hiervoor het kopje Environment Variables

Als laatst moet je de database client genereren en dependencies installeren.

npm install
npx prisma generate
cd backend; npm install

Hierna moet je je database opzetten, zie kopje Database

Daarna kan je de development server starten met npm run dev

Database

IBS3 gebruikt 3 databases, MariaDB, MongoDB en Redis.

MariaDB

Om MariaDB lokaal te draaien moet je even een kopie van de productie database maken, en dan kan je aan de slag. Er is ook een gehoste development database, vraag Niels hierna.

Redis en mongo

Redis en mongo zijn niet verplicht, je kan ze uitschakelen met de volgende environment variables:

DISABLE_MONGO=true
DISABLE_REDIS=true

Redis is makkelijk lokaal te draaien in docker.

docker run -d -p 6379:6379 --name redis redis

Zelfde geldt voor Mongo

docker run -d -p 27017:27017 --name mongo mongo

Tasks

IBS3 is in staat om dingen op de achtergrond te draaien, buiten een request om. Dit is nice voor dingen die (redelijk) wat tijd kosten, zoals emails versturen. Hiervoor gebruiken we een express/node-cron backend. Deze start in development automatisch op als je npm run dev doet.

Cronjobs

Een cronjob is een functie die elke x tijd draait. Zo'n functie kan je maken in /backend/index.ts.

//            crontab    , functie
cron.schedule('1 * * * *', syncLDAPUsers)
// Deze functie wordt elk hele uur uitgevoerd (10:00, 11:00, 12:00) etc

Om te helpen met het maken van een crontab kan je crontab guru gebruiken

Maluspunten

Maluspunten kan worden uitgeschakeld met een environment variable:

PUBLIC_MALUSPUNTEN_ENABLED=true

Environment Variables