salix/README.md

113 lines
2.1 KiB
Markdown
Raw Permalink Normal View History

# Salix
2017-08-30 07:42:12 +00:00
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.
2018-01-12 08:46:04 +00:00
Salix is also the scientific name of a beautifull tree! :)
2017-08-30 07:42:12 +00:00
## Prerequisites
2017-08-30 07:42:12 +00:00
2018-01-29 12:49:59 +00:00
Required applications.
2023-06-15 09:49:39 +00:00
* Node.js >= 16.x LTS
2021-04-16 16:35:03 +00:00
* Docker
* Git
2018-01-29 12:49:59 +00:00
You will need to install globally the following items.
```
$ sudo npm install -g jest gulp-cli
2018-01-29 12:49:59 +00:00
```
For the usage of jest --watch on macOs.
```
$ brew install watchman
```
* [watchman](https://facebook.github.io/watchman/)
2018-03-20 14:03:29 +00:00
## Linux Only Prerequisites
Your user must be on the docker group to use it so you will need to run this command:
```
2018-04-18 12:39:44 +00:00
$ sudo usermod -a -G docker yourusername
2018-03-20 14:03:29 +00:00
```
2017-08-30 07:42:12 +00:00
## Getting Started // Installing
2017-08-30 07:42:12 +00:00
2018-01-12 08:41:18 +00:00
Pull from repository.
2017-08-30 07:42:12 +00:00
2018-01-29 12:49:59 +00:00
Run this commands on project root directory to install Node dependencies.
```
2018-01-12 08:41:18 +00:00
$ npm install
$ gulp install
2018-01-29 12:49:59 +00:00
```
Launch application in developer environment.
```
$ gulp
```
2017-08-30 07:42:12 +00:00
Manually reset fixtures.
2018-01-29 12:49:59 +00:00
```
2018-01-12 08:41:18 +00:00
$ gulp docker
2018-01-29 12:49:59 +00:00
```
2018-01-12 08:41:18 +00:00
## Running the unit tests
2017-08-30 07:42:12 +00:00
2018-01-29 12:49:59 +00:00
For client-side unit tests run from project's root.
```
$ npm run test:front
2018-01-29 12:49:59 +00:00
```
2017-08-30 07:42:12 +00:00
2018-01-29 12:49:59 +00:00
For server-side unit tests run from project's root.
```
$ npm run test:back
2018-01-29 12:49:59 +00:00
```
2017-09-08 12:37:55 +00:00
For end-to-end tests run from project's root.
2018-01-29 12:49:59 +00:00
```
$ npm run test:e2e
2018-01-29 12:49:59 +00:00
```
2021-04-01 11:34:21 +00:00
## Visual Studio Code extensions
2020-06-11 09:16:28 +00:00
2021-04-01 11:32:42 +00:00
Open Visual Studio Code, press Ctrl+P and paste the following commands.
2020-06-11 09:16:28 +00:00
2023-06-15 09:49:39 +00:00
In Visual Studio Code we use the ESLint extension.
2020-06-11 09:16:28 +00:00
```
ext install dbaeumer.vscode-eslint
```
2021-04-01 11:32:42 +00:00
Gitlens for visualization of code authorship
```
ext install eamodio.gitlens
```
Spanish language pack
```
ext install ms-ceintl.vscode-language-pack-es
```
2021-04-01 11:34:21 +00:00
### Recommended extensions
2021-04-01 11:32:42 +00:00
Material icon Theme
```
ext install pkief.material-icon-theme
```
Material UI Themes
```
ext install equinusocio.vsc-material-theme
```
2017-08-30 07:42:12 +00:00
## 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/)
2019-09-13 14:09:14 +00:00
* [jest](https://jestjs.io/)
* [Jasmine](https://jasmine.github.io/)
* [Puppeteer](https://pptr.dev/)