diff --git a/How-to-Build.md b/How-to-Build.md new file mode 100644 index 0000000..ae0cd74 --- /dev/null +++ b/How-to-Build.md @@ -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 +``` + +