Skip to content
Snippets Groups Projects
Commit c42fe11a authored by Sander August Heggland Schrader's avatar Sander August Heggland Schrader
Browse files

added readme

parent 3207eed3
No related branches found
No related tags found
1 merge request!151added readme
Pipeline #182197 passed
# frontend # BoCo - Frontend
<img src="public/favicon.ico" height="100" title="hover text">
## Table of contents
1. [instalasjon](#project-setup)
1. [Running the project](#running-the-project)
1. [Running tests](#running-tests)
## Project setup ## Project setup
To run the frontend node.js is required.
- Installation links
- [node.js](https://nodejs.org/en/download/)
Install required dependencies by running
``` ```
npm install npm install
``` ```
### Compiles and hot-reloads for development The frontend cannot run by iteself and requires a backend service. The URL to this backend service needs to be provided in the enviormental variables. This can be done in these steps
```
npm run serve
```
### Compiles and minifies for production - Create a file with the name ``.env`` in the root folder
``` - If the backend service uses the default configuration insert into the file
npm run build ```
``` VUE_APP_BASEURL=http://localhost:3000/api/
```
### Run your unit tests
```
npm run test:unit
```
### Lints and fixes files ## Running the project
- To compile and run with hot-reloads for development
```
npm run serve
```
- To compile and minifi project for prodoction
```
npm run build
```
## Running tests
To run the tests run the command:
``` ```
npm run lint npm run test:unit
``` ```
This will run all the tests and provide a coverage report. Due to a bug with jest and vue there are tests and files missing in the coverage report. This is due to jest skipping files with ``ES6`` import.
### Customize configuration ### Customize configuration
See [Configuration Reference](https://cli.vuejs.org/config/). See [Configuration Reference](https://cli.vuejs.org/config/).
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