Created How to Build (markdown)

Nicolas Constant 2020-02-08 12:52:58 -05:00
parent c1ba79bd5a
commit fc0167019e
1 changed files with 46 additions and 0 deletions

46
How-to-Build.md Normal file

@ -0,0 +1,46 @@
# How to build and run Sengi
## Prerequisites
### Node.js
You will need [Node.js](https://nodejs.org/en/) v10 installed
(due to Angular 7 incompatibilities, don't use v11 or higher)
### Angular CLI
If you never installed Angular CLI, run:
```
npm install @angular/cli --global
```
## Restore packages
In the root folder, run:
```
npm install
```
## Build and run the project
Here are the most common commands:
### Run angular
```
npm start
```
### Run electron
```
npm run electron
```
### Build angular for publication
```
npm run build
```
### Run unit tests
```
npm test
```