Skip to content
Snippets Groups Projects
Commit 4a551f0c authored by Joakim's avatar Joakim
Browse files

Created README

parent f0cfc83d
No related branches found
No related tags found
No related merge requests found
Pipeline #225879 passed
# frontend
## Project setup
```
npm install
```
### Compiles and hot-reloads for development
```
npm run serve
```
### Compiles and minifies for production
```
npm run build
```
### Run unit tests
```
npm run test:unit
```
### Lints and fixes files
```
npm run lint
```
### Run mock pipeline (build, test, lint)
```
npm run pipeline
```
### Customize configuration
See [Configuration Reference](https://cli.vuejs.org/config/).
# Smart Mat Frontend README
## Table of Contents
1. Prerequisites
2. Installation
3. Running the Application
4. Running the tests
---
### 1. Prerequisites
Before starting make sure that the following tools and software are installed on your machine:
- Node.js: [Download Node.js](https://nodejs.org/en/download)
---
### 2. Installation
Download the source code from the repository
---
### 3. Running the Application
1. Make sure you have installed the backend part of the application and that the server is running
2. Open a terminal and navigate to the root folder of the project
3. Run the following commands in order
- `npm install`
- `npm run serve`
4. Open your preferred browser and go to: `http://localhost:5000`
Thats it, you are all set to start using the application!
---
### 4. Running the tests
This project has two different test types, Unit tests with Vitest and End-To-End tests using Cypress.
**Running Unit tests:**
- Navigate to the root folder of the project.
- Run the following command: npm run test:unit
**Running E2E tests:**
- Create a user with following credentials:
- Email: test@test.com
- Password: 123456789
- Make sure the backend is running
- Run the following command: npm cypress run
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment