salix/README.md

83 lines
1.8 KiB
Markdown
Raw Normal View History

2017-08-30 07:42:12 +00:00
# Project Title
2018-01-12 08:46:04 +00:00
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.
Salix is also the scientific name of a beautifull tree! :)
2017-08-30 07:42:12 +00:00
### Prerequisites
2018-01-12 08:41:18 +00:00
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
2018-01-12 08:41:18 +00:00
install nginx globally.
2017-08-30 07:42:12 +00:00
## Getting Started // ### Installing
2018-01-12 08:41:18 +00:00
Pull from repository.
2017-08-30 07:42:12 +00:00
2018-01-12 08:41:18 +00:00
install nodejs v6.
2017-08-30 07:42:12 +00:00
2018-01-12 08:41:18 +00:00
Ask a senior developer for the datasources.development.json files required to run the project.
2017-08-30 07:42:12 +00:00
on root run:
2018-01-12 08:41:18 +00:00
$ npm install
$ gulp install
2017-08-30 07:42:12 +00:00
lauching nginx:
2018-01-12 08:41:18 +00:00
$ ./dev.sh
2017-08-30 07:42:12 +00:00
launching frontend:
2018-01-12 08:41:18 +00:00
$ gulp client
or start nginx before client on sequence
$ gulp clientDev
2017-08-30 07:42:12 +00:00
launching backend:
2018-01-12 08:41:18 +00:00
$ gulp services
or start the local database before services on sequence
$ gulp serivcesDev
Manually reset local fixtures:
$ gulp docker
to check docker images and containers status:
$ docker images
$ docker ps -a
2017-08-30 07:42:12 +00:00
## Running the tests
2017-09-08 12:37:55 +00:00
for client-side unit tests run from project's root:
2018-01-12 08:41:18 +00:00
$ karma start
2017-08-30 07:42:12 +00:00
2017-09-08 12:37:55 +00:00
for server-side unit tests run from project's root:
2018-01-12 08:41:18 +00:00
$ npm run test
2017-09-08 12:37:55 +00:00
2017-08-30 07:42:12 +00:00
### Break down into end to end tests
2018-01-12 08:41:18 +00:00
Run local database plus e2e paths:
$ gulp e2e
2018-01-12 08:41:18 +00:00
Just the e2e paths as the fixtures are untainted:
$ npm run e2e
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/)
## Versioning
We use [SourceTree](https://www.sourcetreeapp.com/) for versioning. For the versions available, see the [salix project](https://git.verdnatura.es).
## License
This project is licensed under the MIT License