diff --git a/.gitignore b/.gitignore index 96e44e9bd..0f2696626 100644 --- a/.gitignore +++ b/.gitignore @@ -6,4 +6,3 @@ debug.log datasources.test.json datasources.development.json .idea -.idea diff --git a/README.md b/README.md index 248d1a1e5..5e913874a 100644 --- a/README.md +++ b/README.md @@ -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! :) -### Prerequisites +## Prerequisites Required applications. * Node.js >= 8.9.4 * NGINX +* Docker You will need to install globally the following items. ``` -$ npm install -g karma $ npm install -g karma-cli $ npm install -g gulp $ npm install -g webpack $ npm install -g nodemon ``` -## Getting Started // ### Installing +## Getting Started // Installing 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. ``` $ npm install @@ -37,35 +35,18 @@ Launch application in developer environment. $ gulp ``` -Also you can run backend and frontend as independent gulp tasks. - -Launching frontend. +Also you can run backend and frontend as separately gulp tasks (including NGINX). ``` $ gulp client -``` - -Launching backend. It restarts NGINX and Node services. -``` $ gulp services ``` -Start the local database before services on sequence. -``` -$ gulp servicesDev -``` - -Manually reset local fixtures. +Manually reset fixtures. ``` $ gulp docker ``` -To check docker images and containers status. -``` -$ docker images -$ docker ps -a -``` - -## Running the tests +## Running the unit tests 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. ``` -$ npm run test +$ gulp test ``` -### Break down into end to end tests - -Run local database plus e2e paths. +For end-to-end tests run from project's root. ``` $ gulp e2e ``` -Just the e2e paths as the fixtures are untainted. -``` -$ npm run e2e -``` - ## Built With * [angularjs](https://angularjs.org/) @@ -97,7 +71,6 @@ $ npm run e2e * [loopback](https://loopback.io/) * [docker](https://www.docker.com/) * [gulp.js](https://gulpjs.com/) - -## Versioning - -We use [SourceTree](https://www.sourcetreeapp.com/) for versioning. For the versions available, see the [salix project](https://git.verdnatura.es). +* [Karma](https://karma-runner.github.io/) +* [Jasmine](https://jasmine.github.io/) +* [Nightmare](http://www.nightmarejs.org/) diff --git a/package.json b/package.json index 28a251c76..7478c6de7 100644 --- a/package.json +++ b/package.json @@ -18,11 +18,11 @@ "flatpickr": "^2.6.3", "material-design-lite": "^1.3.0", "mg-crud": "^1.1.2", - "nodemon": "^1.12.1", "oclazyload": "^0.6.3", "validator": "^6.2.1" }, "devDependencies": { + "nodemon": "^1.12.1", "angular-mocks": "^1.6.6", "babel": "^6.5.2", "babel-core": "^6.22.1", @@ -71,10 +71,6 @@ "webpack-dev-server": "^2.2.0" }, "scripts": { - "build": "webpack --progress --colors", - "dev": "webpack-dev-server --progress --colors", - "lint": "eslint ./ --cache --ignore-pattern .gitignore", - "test": "nodemon -q services_tests.js -w services", - "e2e": "node e2e_tests" + "lint": "eslint ./ --cache --ignore-pattern .gitignore" } }