salix/README.md

# 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.

* Docker
* Git

Optional.

- NodeJS


## Directory structure recommendation
- /Salix
    - /back ← this project
    - /front ← salix-front project

## Installing dependencies and launching

Pull from repository.
```sh
$ git clone [url] [directory]
```

Run this commands on project root directory to install Node dependencies.
```sh
$ sh init.sh
```

Launch application in developer environment.
```sh
$ docker compose -f docker-compose.local.yml up
```

With NodeJS
```sh
$ npm run start
```

Manually reset fixtures.
```sh
$ docker compose -f docker-compose.local.yml up --build
```

With NodeJS
```sh
$ npm run restart
```
## Running the unit tests

For client-side unit tests run from project's root.
```sh
$ sh runTestFront.sh
```

With NodeJS
```sh
$ npm run test:front
```

For server-side unit tests run from project's root.
```sh
$ sh runTestBack.sh
```

With NodeJS
```sh
$ npm run test:back
```

For end-to-end tests run from project's root.
```
$ npm run test:e2e
```

## 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/)