salix/README.md

88 lines
1.6 KiB
Markdown

# Salix
This project is an Enterprise resource planning (ERP) integrated management of core business processes, in real-time and mediated by software and technology developed with the stack listed below.
Salix is also the scientific name of a beautifull tree! :)
## Prerequisites
Required applications.
* Node.js
* Docker
* Git
* MYT
You will need to install globally the following items.
```
$ sudo npm install -g jest gulp-cli
```
After installing MYT you will need the following item.
```
$ apt install libkrb5-dev libssl-dev
```
## Installing dependencies and launching
Pull from repository.
Run this commands on project root directory to install Node dependencies.
```
$ pnpm install
$ gulp install
```
Launch application in developer environment.
```
$ gulp
```
Manually reset fixtures.
```
$ gulp docker
```
## Running the unit tests
For client-side unit tests run from project's root.
```
$ npm run test:front
```
For server-side unit tests run from project's root.
```
$ npm run test:back
```
For end-to-end tests run from project's root.
```
$ npm run test:e2e
```
## Generate changeLog test → master
```
$ bash changelog.sh
```
## Visual Studio Code extensions
Open Visual Studio Code, press Ctrl+P and paste the following commands.
In Visual Studio Code we use the ESLint extension.
```
ext install dbaeumer.vscode-eslint
```
## Built With
* [angularjs](https://angularjs.org/)
* [nodejs](https://nodejs.org/)
* [webpack](https://webpack.js.org/)
* [loopback](https://loopback.io/)
* [docker](https://www.docker.com/)
* [gulp.js](https://gulpjs.com/)
* [jest](https://jestjs.io/)
* [Jasmine](https://jasmine.github.io/)
* [Puppeteer](https://pptr.dev/)