Invictus Bier Systeem is het websysteem voor O.D.D. Invictus.
IBS3 gebruikt bun 1.3.6
Om te beginnen met ontwikkelen moet je eerst de repository clonen met
git clone git@github.com:ODDInvictus/ibs3.gitals 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.
bun install
bunx prisma generate
cd backend; bun installHierna moet je je database opzetten, zie kopje Database
Daarna kan je de development server starten met bun run dev
IBS3 gebruikt als database 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.
| Sleutel | Waarde | Voorbeeld | | ---------------------------- | ------------------------------------------------------------------------------------- | ----------------------------------------------------- | --- | | DATABASE_URL | MySQL connection string | mysql://ibs3:password@mariadb:3306/ibs3?schema=public | | IBS_CLIENT_ID | Client ID in Authentik | ibs | | IBS_CLIENT_SECRET | Client Secret in Authentik | bjdsbjadshbjsbjsdbjabdhwvdksd | | IBS_ISSUER | Issuer url vanuit Authentik | https://auth.example.com/application/o/ibs/ | | | ORIGIN | URL waar deze app gevonden kan worden | https://ibs.example.com | | DISCORD_NOTIFICATION_WEBHOOK | Webhook URL voor discord kanaal waar errors in gepost worden | https://discord.com/api/webhooks/server/key | | BACKEND_PORT | Poort waarop de backend draait | 3001 | | UPLOAD_FOLDER | Map op de schijf waar uploads opgeslagen worden | ./static/upload | | BACKEND_URL | URL waar de backend op te vinden is | http://localhost:3000 | | UPLOAD_FOLDER | Pad waar foto's naar geupload worden | ./upload | | STATIC_FOLDER | Waar static files gevonden kunnen worden | ./static | | IMAGE_CACHE_TIME | Hoelang een image in de cache blijft | 86400 | | QUOTE_API_URL | Url naar de quote api | ... | | QUOTE_API_TOKEN | API Token voor de quote api | ... | | PUBLIC_SPOTIFY_CLIENT_ID | Client id voor spotify | ... | | SPOTIFY_CLIENT_SECRET | Client secret voor spotify | ... | | PUBLIC_SPOITFY_REDIRECT_URI | Redirect uri voor spotify, alles van spotify is alleen nodig voor de playlist feature | http://localhost:5173/playlist/callback |