69 lines
1.3 KiB
Markdown
69 lines
1.3 KiB
Markdown
# Project Title
|
|
|
|
One Paragraph of project description goes here
|
|
|
|
### Prerequisites
|
|
|
|
For testing purposes you will need to install globally the following items:
|
|
npm install -g karma
|
|
npm install -g karma-cli
|
|
|
|
## Getting Started // ### Installing
|
|
|
|
Pull from repo.
|
|
|
|
install nodejs v6 or above.
|
|
|
|
install nginx globally.
|
|
|
|
Ask a senior dev for the datasources.development.json files required to run the project.
|
|
|
|
on root run:
|
|
npm install
|
|
gulp install
|
|
|
|
lauching nginx:
|
|
./dev.sh
|
|
|
|
launching frontend:
|
|
gulp client
|
|
|
|
launching backend:
|
|
gulp services
|
|
|
|
## 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 testWatch or test for single run
|
|
|
|
### Break down into end to end tests
|
|
|
|
on root run:
|
|
|
|
gulp docker
|
|
|
|
wait 10 secs for db to be ready
|
|
|
|
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).
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License
|
|
|