salix/README.md

112 lines
2.1 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 = 14.15.1 LTS
* Docker
You will need to install globally the following items.
```
$ sudo npm install -g jest gulp-cli
```
For the usage of jest --watch on macOs.
```
$ brew install watchman
```
* [watchman](https://facebook.github.io/watchman/)
## Linux Only Prerequisites
Your user must be on the docker group to use it so you will need to run this command:
```
$ sudo usermod -a -G docker yourusername
```
## Getting Started // Installing
Pull from repository.
Run this commands on project root directory to install Node dependencies.
```
$ npm 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.
```
$ jest
```
For server-side unit tests run from project's root.
```
$ gulp backTest
```
For end-to-end tests run from project's root.
```
$ gulp 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
```
Gitlens for visualization of code authorship
```
ext install eamodio.gitlens
```
Spanish language pack
```
ext install ms-ceintl.vscode-language-pack-es
```
### Recommended extensions
Material icon Theme
```
ext install pkief.material-icon-theme
```
Material UI Themes
```
ext install equinusocio.vsc-material-theme
```
## 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/)