salix/README.md

77 lines
1.5 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.
* Node.js >= 8.9.4
* NGINX
* Docker
2018-01-29 12:49:59 +00:00
You will need to install globally the following items.
```
2018-01-12 08:41:18 +00:00
$ npm install -g karma-cli
$ npm install -g gulp
$ npm install -g webpack
$ npm install -g nodemon
2018-01-29 12:49:59 +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
Also you can run backend and frontend as separately gulp tasks (including NGINX).
2018-01-29 12:49:59 +00:00
```
2018-01-12 08:41:18 +00:00
$ gulp client
$ gulp services
2018-01-29 12:49:59 +00:00
```
2018-01-12 08:41:18 +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.
```
2018-01-12 08:41:18 +00:00
$ karma start
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.
```
2018-02-01 15:01:49 +00:00
$ npm run test
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
```
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/)
* [Karma](https://karma-runner.github.io/)
* [Jasmine](https://jasmine.github.io/)
* [Nightmare](http://www.nightmarejs.org/)