Skip to content

Latest commit

 

History

History
64 lines (55 loc) · 2.35 KB

README.md

File metadata and controls

64 lines (55 loc) · 2.35 KB
Raw

Project pigeonhole frontend

tests linter

Prerequisites

1. Clone the repo

git clone git@github.com:SELab-2/UGent-3.git

2. Installing required packages Run the command below to install the needed dependencies.

cd frontend
npm install

After this you can run the development or the production build with one of the following command

  • Deployment
 npm run build

After running this command the build can be found in the dist directory. You can choose your own preferred webserver like for example nginx, serve or something else.

  • Development
npm run dev

Setting up the environment variables

This application requires a couple of environment variables to run. Setting values for these variables can be done with a method to your own liking.

Variable Description
VITE_API_HOST URL of the API
VITE_APP_TENANT_ID Tenant id
VITE_APP_CLIENT_ID Client id

Maintaining the codebase

Writing tests

When writing new code it is important to maintain the right functionality so writing tests is mandatory for this, the test library used in this codebase is cypres e2e.

If you want to write tests we highly advise to read the cypres e2e documentation on how to write tests, so they are kept conventional.

For executing the tests and testing your newly added functionality you can run:

npm run dev

After the development build is running, you can run the following command on another terminal:

npm run test

Running the linter

This codebase is kept clean by the eslint linter.

If you want to execute the linter on all files in the project it can simply be done with the command:

npm run lint