104 lines
1.9 KiB
Markdown
104 lines
1.9 KiB
Markdown
# Project Title
|
|
|
|
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! :)
|
|
|
|
### Prerequisites
|
|
|
|
Required applications.
|
|
|
|
* Node.js >= 8.9.4
|
|
* NGINX
|
|
|
|
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
|
|
|
|
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
|
|
$ gulp install
|
|
```
|
|
|
|
Launch application in developer environment.
|
|
```
|
|
$ gulp
|
|
```
|
|
|
|
Also you can run backend and frontend as independent gulp tasks.
|
|
|
|
Launching frontend.
|
|
```
|
|
$ 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.
|
|
```
|
|
$ gulp docker
|
|
```
|
|
|
|
To check docker images and containers status.
|
|
```
|
|
$ docker images
|
|
$ docker ps -a
|
|
```
|
|
|
|
## Running the tests
|
|
|
|
For client-side unit tests run from project's root.
|
|
```
|
|
$ karma start
|
|
```
|
|
|
|
For server-side unit tests run from project's root.
|
|
```
|
|
$ npm run test
|
|
```
|
|
|
|
### Break down into end to end tests
|
|
|
|
Run local database plus e2e paths.
|
|
```
|
|
$ gulp e2e
|
|
```
|
|
|
|
Just the e2e paths as the fixtures are untainted.
|
|
```
|
|
$ npm run e2e
|
|
```
|
|
|
|
## 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).
|