README and LICENSE updated
This commit is contained in:
parent
f4a790f87c
commit
97adf0a39e
|
@ -0,0 +1,17 @@
|
||||||
|
Copyright (C) 2018 - Verdnatura Levante S.L.
|
||||||
|
|
||||||
|
This package is free software; you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
On Debian systems, the complete text of the GNU General Public
|
||||||
|
License can be found in "/usr/share/common-licenses/GPL-3".
|
71
README.md
71
README.md
|
@ -6,62 +6,88 @@ Salix is also the scientific name of a beautifull tree! :)
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
|
|
||||||
You will need to install globally the following items:
|
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
|
||||||
$ 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
|
||||||
|
```
|
||||||
install nginx globally.
|
|
||||||
|
|
||||||
## Getting Started // ### Installing
|
## Getting Started // ### Installing
|
||||||
|
|
||||||
Pull from repository.
|
Pull from repository.
|
||||||
|
|
||||||
install nodejs v6.
|
|
||||||
|
|
||||||
Ask a senior developer for the datasources.development.json files required to run the project.
|
Ask a senior developer for the datasources.development.json files required to run the project.
|
||||||
|
|
||||||
on root run:
|
Run this commands on project root directory to install Node dependencies.
|
||||||
|
```
|
||||||
$ npm install
|
$ npm install
|
||||||
$ gulp install
|
$ gulp install
|
||||||
|
```
|
||||||
|
|
||||||
lauching nginx:
|
Launch application in developer environment.
|
||||||
$ ./dev.sh
|
```
|
||||||
|
$ gulp
|
||||||
|
```
|
||||||
|
|
||||||
launching frontend:
|
Also you can run backend and frontend as independent gulp tasks.
|
||||||
|
|
||||||
|
Launching frontend.
|
||||||
|
```
|
||||||
$ gulp client
|
$ gulp client
|
||||||
or start nginx before client on sequence
|
```
|
||||||
$ gulp clientDev
|
|
||||||
|
|
||||||
launching backend:
|
Launching backend. It restarts NGINX and Node services.
|
||||||
|
```
|
||||||
$ gulp services
|
$ gulp services
|
||||||
or start the local database before services on sequence
|
```
|
||||||
$ gulp serivcesDev
|
|
||||||
|
|
||||||
Manually reset local fixtures:
|
Start the local database before services on sequence.
|
||||||
|
```
|
||||||
|
$ gulp servicesDev
|
||||||
|
```
|
||||||
|
|
||||||
|
Manually reset local fixtures.
|
||||||
|
```
|
||||||
$ gulp docker
|
$ gulp docker
|
||||||
|
```
|
||||||
|
|
||||||
to check docker images and containers status:
|
To check docker images and containers status.
|
||||||
|
```
|
||||||
$ docker images
|
$ docker images
|
||||||
$ docker ps -a
|
$ docker ps -a
|
||||||
|
```
|
||||||
|
|
||||||
## Running the tests
|
## Running the tests
|
||||||
|
|
||||||
for client-side unit tests run from project's root:
|
For client-side unit tests run from project's root.
|
||||||
|
```
|
||||||
$ karma start
|
$ 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
|
$ npm run test
|
||||||
|
```
|
||||||
|
|
||||||
### Break down into end to end tests
|
### Break down into end to end tests
|
||||||
|
|
||||||
Run local database plus e2e paths:
|
Run local database plus e2e paths.
|
||||||
|
```
|
||||||
$ gulp e2e
|
$ gulp e2e
|
||||||
|
```
|
||||||
|
|
||||||
Just the e2e paths as the fixtures are untainted:
|
Just the e2e paths as the fixtures are untainted.
|
||||||
|
```
|
||||||
$ npm run e2e
|
$ npm run e2e
|
||||||
|
```
|
||||||
|
|
||||||
## Built With
|
## Built With
|
||||||
|
|
||||||
|
@ -75,8 +101,3 @@ $ npm run e2e
|
||||||
## Versioning
|
## Versioning
|
||||||
|
|
||||||
We use [SourceTree](https://www.sourcetreeapp.com/) for versioning. For the versions available, see the [salix project](https://git.verdnatura.es).
|
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
|
|
||||||
|
|
||||||
|
|
|
@ -3,10 +3,10 @@
|
||||||
"version": "1.0.0",
|
"version": "1.0.0",
|
||||||
"author": "Verdnatura Levante SL",
|
"author": "Verdnatura Levante SL",
|
||||||
"description": "Salix application",
|
"description": "Salix application",
|
||||||
"license": "ISC",
|
"license": "GPL-3.0",
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "http://git.verdnatura.es:/salix"
|
"url": "https://git.verdnatura.es/salix"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@uirouter/angularjs": "^1.0.3",
|
"@uirouter/angularjs": "^1.0.3",
|
||||||
|
|
Loading…
Reference in New Issue