P3K TEAM - Team web

Table of contents

1. Prerequisites
2. Installation and development
3. Test coverage
   • E2E Tests
   • Unit Tests
4. Deploying to the web
5. Keeping documents updated

Prerequisites

• Node.js
• Node package manager

Installation and development

The application is written in reactive framework Vue.

1. Installing dependencies

   npm install

2. Running the dev server

   npm run serve

3. Visit the webpage in browser (by default the URL is http://localhost:8080)

Test coverage

E2E Tests

E2E test tests the application from the end user’s perspective. It tests the application whether are all components successfully integrated together. For more information see the this guide.

Unit Tests

Unit tests allow you to test individual units of code in isolation. The purpose of unit testing is to provide developers with confidence in their code. By writing thorough, meaningful tests, you achieve the confidence that as new features are built or your code is refactored your application will remain functional and stable. You can learn about unit tests here.

Deploying to the web

The code is automatically deployed to the webserver using CI pipeline after merge into master branch.

Keeping documents updated

As our webpage is not connected to any database, the data provided are static and need to be updated manually. Moreover, our workflow consists of writing the documentation in LaTeX and we use another repository to compile the files. All the information is provided in the Uploading documents doc.