API-KIOSK

Description

API-KIOSK is a back-end project made for the University of Gdańsk. It will be used in the information kiosk located outside of the MFI building.

Technologies

API-KIOSK uses:

• TypeScript
• Express
• MongoDB Atlas database

Tests

This app uses Jest for both unit and coverage testing.

CI & CD

CI pipeline runs on every pull request to any branch, while CD runs on every merge to main branch.

Production site

You can check the deployment for development and for production.

---

Setup

In order to run this app, you need to have Docker (and Docker Compose) installed and running on your environment. You can check versions of both by running following commands:

$ docker --version
Docker version 20.10.23, build 7155243
$ docker compose version
Docker Compose version v2.15.1

You also need Yarn to run scripts, add dependencies and install packages:

$ yarn --version
1.22.19

---

How to work with this repository

Install

Clone repo:

$ git clone https://github.com/UniversityOfGdanskProjects/API-KIOSK.git

or

$ git clone [email protected]:UniversityOfGdanskProjects/API-KIOSK.git

After cloning:

$ cd API-KIOSK

Start development server

$ yarn up

By default, the server starts on port 3001.

Build production image

$ docker build .

Run unit tests inside container

$ yarn test:unit

Run coverage tests inside container

$ yarn test:coverage

---

Contribution

In order to contribute to the repository, check out the contribution guide.