Skip to content
This repository has been archived by the owner on Feb 26, 2023. It is now read-only.

Team3132/AttendanceBackend

Repository files navigation


TDU Attendance API/Backend

Links

Description

A project started to better coordinate both student and mentor attendance.

Stack

  • NestJS - An extensible framework for building APIs with NodeJS. Comes with many utility packages to implement common API features like authentication.
  • Prisma - A database ORM used to interact with the postgres db that stores all the project's data.
  • Discord-NestJS - A NestJS module for building discord bots. Allows direct connection with API functions through dependancy injection.

Getting started

If you want to familiarise yourself with how NestJS works in detail I would recommend watching this video. Though editing the codebase should not require too high a level of understanding.

Deployment

Currently the project builds a docker container when the Github Action is manually triggered. This allows deployment to a variety of platforms pretty easily. At the moment I'm using Cloudflare tunnels on my server machine at home to link it the the team3132.com domain.