UI-KIOSK

Description

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

Technologies

UI-KIOSK uses:

• Typescript
• React
• Redux

Bundler

This project is bundled by Vite.

Tests

This app uses Jest for unit testing and Cypress for end-to-end testing.

CI & CD

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

Production site

You can check the deployment site here.

---

Setup

In order to run this app, you need to have Node installed on your environment. You can check your Node version by running following command:

$ node --version
v18.12.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/UI-KIOSK.git

or

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

After cloning:

$ cd UI-KIOSK
$ yarn install

Start development server

$ yarn start

By default, the server starts on port 3000.

Build for production

$ yarn build

Run unit tests

$ yarn test

Run end-to-end tests

$ yarn cy:e2e

---

Contribution

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