verdnatura/salix
verdnatura
/
salix
3
4
Fork 0
Code Issues Pull Requests 59 Releases Wiki Activity

README update plus package.json nodemon to dev dependencies

This commit is contained in:
Carlos Jimenez 2018-02-01 15:48:19 +01:00
parent f434de30c3
commit c94fe12f91
3 changed files with 15 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -6,4 +6,3 @@ debug.log
datasources.test.json datasources.test.json
datasources.development.json datasources.development.json
.idea .idea
.idea

53
README.md
View File

@ -1,31 +1,29 @@
# Project Title # Salix
Salix 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. 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! :) Salix is also the scientific name of a beautifull tree! :)
### Prerequisites ## Prerequisites
Required applications. Required applications.
* Node.js >= 8.9.4 * Node.js >= 8.9.4
* NGINX * NGINX
* Docker
You will need to install globally the following items. You will need to install globally the following items.
``` ```
$ npm install -g karma
$ npm install -g karma-cli $ npm install -g karma-cli
$ npm install -g gulp $ npm install -g gulp
$ npm install -g webpack $ npm install -g webpack
$ npm install -g nodemon $ npm install -g nodemon
``` ```
## Getting Started // ### Installing ## Getting Started // Installing
Pull from repository. Pull from repository.
Ask a senior developer for the datasources.development.json files required to run the project.
Run this commands on project root directory to install Node dependencies. Run this commands on project root directory to install Node dependencies.
``` ```
$ npm install $ npm install
@ -37,35 +35,18 @@ Launch application in developer environment.
$ gulp $ gulp
``` ```
Also you can run backend and frontend as independent gulp tasks. Also you can run backend and frontend as separately gulp tasks (including NGINX).
Launching frontend.
``` ```
$ gulp client $ gulp client
```
Launching backend. It restarts NGINX and Node services.
```
$ gulp services $ gulp services
``` ```
Start the local database before services on sequence. Manually reset fixtures.
```
$ gulp servicesDev
```
Manually reset local fixtures.
``` ```
$ gulp docker $ gulp docker
``` ```
To check docker images and containers status. ## Running the unit tests
```
$ docker images
$ docker ps -a
```
## Running the tests
For client-side unit tests run from project's root. For client-side unit tests run from project's root.
``` ```
@ -74,21 +55,14 @@ $ karma start
For server-side unit tests run from project's root. For server-side unit tests run from project's root.
``` ```
$ npm run test $ gulp test
``` ```
### Break down into end to end tests For end-to-end tests run from project's root.
Run local database plus e2e paths.
``` ```
$ gulp e2e $ gulp e2e
``` ```
Just the e2e paths as the fixtures are untainted.
```
$ npm run e2e
```
## Built With ## Built With
* [angularjs](https://angularjs.org/) * [angularjs](https://angularjs.org/)
@ -97,7 +71,6 @@ $ npm run e2e
* [loopback](https://loopback.io/) * [loopback](https://loopback.io/)
* [docker](https://www.docker.com/) * [docker](https://www.docker.com/)
* [gulp.js](https://gulpjs.com/) * [gulp.js](https://gulpjs.com/)
* [Karma](https://karma-runner.github.io/)
## Versioning * [Jasmine](https://jasmine.github.io/)
* [Nightmare](http://www.nightmarejs.org/)
We use [SourceTree](https://www.sourcetreeapp.com/) for versioning. For the versions available, see the [salix project](https://git.verdnatura.es).

8
package.json
View File

@ -18,11 +18,11 @@
"flatpickr": "^2.6.3", "flatpickr": "^2.6.3",
"material-design-lite": "^1.3.0", "material-design-lite": "^1.3.0",
"mg-crud": "^1.1.2", "mg-crud": "^1.1.2",
"nodemon": "^1.12.1",
"oclazyload": "^0.6.3", "oclazyload": "^0.6.3",
"validator": "^6.2.1" "validator": "^6.2.1"
}, },
"devDependencies": { "devDependencies": {
"nodemon": "^1.12.1",
"angular-mocks": "^1.6.6", "angular-mocks": "^1.6.6",
"babel": "^6.5.2", "babel": "^6.5.2",
"babel-core": "^6.22.1", "babel-core": "^6.22.1",
@ -71,10 +71,6 @@
"webpack-dev-server": "^2.2.0" "webpack-dev-server": "^2.2.0"
}, },
"scripts": { "scripts": {
"build": "webpack --progress --colors", "lint": "eslint ./ --cache --ignore-pattern .gitignore"
"dev": "webpack-dev-server --progress --colors",
"lint": "eslint ./ --cache --ignore-pattern .gitignore",
"test": "nodemon -q services_tests.js -w services",
"e2e": "node e2e_tests"
} }
} }