About

This repo is about displaying analytics for students doing the bootcamp. This app has three main components:

• A REST API (HTTP POST) that accepts a payload posted by Github Webhooks
• Sveltekit app to display the analytics
• A script that should be run at the beginning of a new cohort

Setting up the environment

This app is intended to be live all the time, since github will constantly trigger the Webhook to your API route. So it's recommended to deploy the app to a hosting service.

.env

1. Generate a new github token and assign it to GITHUB_TOKEN
2. Assign the name of the cohort to GITHUB_ORG
3. Create a remote database and assign it to DATABASE_URL

npm i
npm run dev

Setting up a webhook in the cohorts organisation

• Go to Settings / Webhooks.
• Add a new webhook.
• the "Payload URL" should be the deployed app url "https://student-dashboard-akl.devacademy.life/api/commits"
• the webhook Content-Type should be set to JSON
• Make sure the SSL verification is enabled.

Deploying to dokku:

• the usual stuff for deploying an app with database, but some extras (cause its a prisma / postgres db instead of sqlite)
• Set the cohort: dokku config:set GITHUB_ORG=kahikatea-2024 and then run the new-cohort script: dokku run npm run new:cohort and then it should all be great

TODO Tasks

• Use @tanstack/table to add more interactivity (clicking columns to sort)
• Add charts using svg and svelte