salix/README.md

82 lines
1.6 KiB
Markdown
Raw 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.
2020-05-30 14:32:05 +00:00
* Node.js = 12.17.0 LTS
* Docker
2018-01-29 12:49:59 +00:00
You will need to install globally the following items.
```
2020-06-11 09:16:28 +00:00
# sudo npm install -g jest gulp-cli
2018-01-29 12:49:59 +00:00
```
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.
```
2019-09-13 14:09:14 +00:00
$ jest
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.
```
$ gulp backTest
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
```
2018-01-12 08:41:18 +00:00
$ gulp e2e
2018-01-29 12:49:59 +00:00
```
2020-06-11 09:16:28 +00:00
## Recommended tools
* Visual Studio Code
In Visual Studio Code we use the ESLint extension. Open Visual Studio Code, press Ctrl+P and paste the following command.
```
ext install dbaeumer.vscode-eslint
```
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/)