Overview of the Hochschule Hannover Modules API
The Hochschule Hannover API provides access to data for all available modules. It is implemented as a backend service that delivers data to the frontend using HTTP REST calls.
StudyModules Documentation
website·Indexed 29 days ago
https://studymodules-docs.tobi.winDocumentation for StudyModules, a system providing data for modules available at Hochschule Hannover. Includes guides for the Angular frontend, Nest.js backend, and REST API, covering setup, authentication via JWT, database migrations with Prisma, and deployment using Podman and GitHub Actions.
What's inside StudyModules
Enable detailed API responses for debugging
Include theDetailed: trueheader in your API requests to receive more comprehensive responses from supported endpoints. This is primarily intended for debugging or scenarios where additional metadata about the response is required. Note that this feature is subject to change or removal in future versions.GET /modules HTTP/1.1 Authorization: Bearer <your_token> Detailed: true Host: localhost:3000Automate backend deployment with GitHub Actions
The backend is configured to automatically build and deploy to the Webserver whenever changes are pushed to the GitHub repository.Backend technology stack overview
The backend is developed using Nest.js and TypeScript. It is designed to serve multiple applications.Understand the StudyModules frontend architecture
The StudyModules frontend serves as a user interface to display all available modules at the Hochschule Hannover. It provides functionality to filter these modules by faculty and course. The frontend is decoupled from the data source, retrieving all necessary information from the backend via HTTP REST calls.Understand the Study Modules Backend Architecture
The backend serves as the data provider for all modules available at the Hochschule Hannover. It exposes this data to the frontend application using HTTP REST calls.Frontend technology stack overview
The frontend of the project is developed using Angular and TypeScript, following modern UI patterns.Automate frontend and documentation deployment with GitHub Actions
The project is configured to use GitHub Actions to automatically build and deploy the frontend and documentation to the designated Webserver whenever changes are pushed to the GitHub repository.Build the StudyModules Frontend for production
Compile the project for web deployment. The build process generates the final files in thedistfolder, which can then be hosted on any web server.npm run build:prodInstall Podman for StudyModules deployment
To deploy StudyModules, install Podman. Podman Desktop is the recommended installation source.Visit https://podman-desktop.io to install.Apply database schema changes using Prisma
To modify the database schema, edit theschema.prismafile. After updating the schema, generate and apply a migration file using the Prisma CLI to synchronize the database state.prisma migrate dev --name <name>Create standalone pages using Markdown
For simple standalone pages that do not require complex interactivity, you can write them directly in Markdown without needing to use React.