https://github.com/kth/kursplan-api
API app to generate course syllabuses for kursinfo-web, kursutveckling-web, and kurs-pm-web.
https://github.com/kth/kursplan-api
express nodejs react react-pdf swagger
Last synced: 5 months ago
JSON representation
API app to generate course syllabuses for kursinfo-web, kursutveckling-web, and kurs-pm-web.
- Host: GitHub
- URL: https://github.com/kth/kursplan-api
- Owner: KTH
- License: mit
- Created: 2018-10-18T09:04:21.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-08-13T08:56:10.000Z (over 1 year ago)
- Last Synced: 2024-08-13T12:50:40.875Z (over 1 year ago)
- Topics: express, nodejs, react, react-pdf, swagger
- Language: JavaScript
- Homepage:
- Size: 6.04 MB
- Stars: 2
- Watchers: 14
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Welcome to kursplan-api 👋
[](#)
## Introduction
The course information project (KIP) is an initiative at KTH that was launched in 2018 to improve the quality and availability of information about KTH:s courses. The background to the project is, among other things, that it was difficult for the student to find information about the courses and even more difficult to compare information about several courses. The reason for the problems is scattered course information in several places and that there is no uniformity or assigned places for the course information. The project takes measures to consolidate course information into two locations and to present the information in a manner that is uniform for KTH. The student should find the right information about the course, depending on their needs. The result of the project is a public course site where the correct course information is collected and presented uniformly. Also, a tool is developed for teachers to enter and publish course information. Eventually, this will lead to the student making better decisions based on their needs, and it will also reduce the burden on teachers and administration regarding questions and support for the student.
Kursplan-api is a microservice to generate course syllabuses for ([kursinfo-web](https://github.com/KTH/kursinfo-web)), ([kursutveckling-web](https://github.com/KTH/kursutveckling-web)) and ([kurs-pm-web](https://github.com/KTH/kurs-pm-web)) It uses [Node.js](https://nodejs.org/), and is based on [https://github.com/KTH/node-api](node-api).
### 🏠 [Homepage](https://github.com/KTH/kursplan-api)
## Overview
Kursplan-api generates syllabuses from Ladok data. [Swagger](https://swagger.io/) is used for API documentation.
Syllabuses are generated in `HTML` or as `PDF`files.
This API is independent and will not break other projects but it is important remember it is logically connected to the bigger picture of course information.
### Related Projects
- [kursinfo-web](https://github.com/KTH/kursinfo-web)
- [kursutveckling-web](https://github.com/KTH/kursutveckling-web)
- [kurs-pm-web](https://github.com/KTH/kurs-pm-web)
- [node-api](https://github.com/KTH/node-api)
- [Swagger](https://swagger.io/)
- [React-pdf](https://react-pdf.org/)
- [html-react-parser](https://github.com/remarkablemark/html-react-parser)
- [studadm-om-kursen-packages] (https://github.com/KTH/studadm-om-kursen-packages)
## Prerequisites
- Node.js 18.0.0
## For Development
### Install
```sh
npm install
```
### Usage
Start the service on [localhost:3001/api/kursplan/swagger](http://localhost:3001/api/kursplan/swagger).
```sh
npm run start-dev
```
## In Production
Secrets and docker-compose are located in cellus-registry.
## Monitor and Dashboards
### Application Status
[localhost:3001/api/kursplan/\_monitor](http://localhost:3001/api/kursplan/_monitor)
### Application Insights
To see more detailed behaviour in project, use `Application Insights`, e.g., `kursinfo-web-stage-application-insights-kthse`.
## Use 🐳
Copy `docker-compose.yml.in` to `docker-compose.yml` and make necessary changes, if any.
```sh
docker-compose up
```
## Deploy in Stage
The deployment process is described in [Build, release, deploy](https://confluence.sys.kth.se/confluence/x/aY3_Ag). Technical details, such as configuration, is described in [How to deploy your 🐳 application using Cellus-Registy](https://gita.sys.kth.se/Infosys/cellus-registry/blob/master/HOW-TO-DEPLOY.md) and [🔧 How To Configure Your Application For The Pipeline](https://gita.sys.kth.se/Infosys/cellus-registry/blob/master/HOW-TO-CONFIGURE.md).
### Edit secrets.env
```sh
ansible-vault edit secrets.env
```
Password find in gsv-key vault
### Configure secrets.env
```
Secrets during local development are stored in a gitignored `.env` file (`env.in` can be used as template for your `.env` file). More details about environment variable setup and secrets can be found in [confluence](https://confluence.sys.kth.se/confluence/x/OYKBDQ).
```
## PDF Generation
The application has an endpoint that generates a PDF syllabus. The PDF file is generated with [React-pdf](https://react-pdf.org/). Syllabus data in `HTML` will be parsed into `React` elements with [html-react-parser](https://github.com/remarkablemark/html-react-parser), before they are added to the document element tree.
`React`components are converted with [Babel](https://babeljs.io/) into`./components-dist/`.
### Syllabus Components
```sh
Syllabus
|-- SyllabusDocument
| |-- SyllabusPages
| |-- SyllabusHead
| |-- SyllabusKeyInformation
| |-- SyllabusBody
| |-- SyllabusPageFooter
|-- SyllabusHtmlParser
|-- SyllabusStyles
```
#### Syllabus
Entry point component. Renders `SyllabusDocument` component.
#### SyllabusDocument
Renders wrapping `Document` component, and `SyllabusPages`.
#### SyllabusPages
Renders `Page` component containing the syllabus’s pages. Inside the `Page` `SyllabusHead`, `SyllabusKeyInformation`, and `SyllabusBody` components are rendered for the syllabus content, and a`SyllabusPageFooter` component for the syllabus’s footers.
#### SyllabusHead
Renders KTH logotype, syllabus heading, and such.
#### SyllabusKeyInformation
Renders syllabus key information.
#### SyllabusBody
Renders syllabus main content with `Section` components. Contains logic for determining which data to use for certain sections.
#### SyllabusPageFooter
Renders footer text and page numbers.
#### SyllabusHtmlParser
Parses `HTML` data into `React` elements. Called from `SyllabusBody`.
#### SyllabusStyles
Contains all styles for PDF components.
## Author
👤 **KTH**
- Website: https://kth.github.io/
- Github: [@KTH](https://github.com/KTH)