diff --git a/README.md b/README.md new file mode 100644 index 000000000..dbad4722b --- /dev/null +++ b/README.md @@ -0,0 +1,61 @@ +# 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. + +inside each service folder run: +npm install + +on root run: +npm install + +Ask a senior dev for the datasources.development.json files required to run the project. + +lauching nginx: +./dev.sh + +launching frontend: +gulp client + +launching backend: +gulp services + +## Running the tests + +for unit tests run from project's root: +karma start + +### Break down into end to end tests + +comming soon. + +## 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 +