diff --git a/README.md b/README.md index a98880f..80e628d 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,39 @@ -# RainCatcher -[![Build Status](https://travis-ci.org/feedhenry-raincatcher/raincatcher-core.svg?branch=master)](https://travis-ci.org/feedhenry-raincatcher/raincatcher-core) [![Coverage Status](https://coveralls.io/repos/github/feedhenry-raincatcher/raincatcher-core/badge.svg?branch=master)](https://coveralls.io/github/feedhenry-raincatcher/raincatcher-core?branch=master) +![Logo](img/logo-blue.png) +> Workforce management platform -Feedhenry RainCatcher Core Repository +[![Build Status](https://travis-ci.org/feedhenry-raincatcher/raincatcher-core.svg?branch=master)](https://travis-ci.org/feedhenry-raincatcher/raincatcher-core) [![Coverage Status](https://coveralls.io/repos/github/feedhenry-raincatcher/raincatcher-core/badge.svg?branch=master)](https://coveralls.io/github/feedhenry-raincatcher/raincatcher-core?branch=master) ## About RainCatcher -## Developing +RainCatcher is a Workforce Management platform with the main focus on delivering a set of modules and user interface for mobile developers who want to integrate WFM features into their application. + +RainCatcher can be divided into following areas: + +- **Workforce Management framework** that provides mobile and website framework for building +Workforce management solutions on top of all supported user interfaces. +- **Set of modules** specific to Workforce management (signatures, scheduler etc.) +- **WFM specific integrations** to provide authentication, storage, offline capabilities and server side synchronization. +- **User interface** implemented in AngularJS and Angular + +### Main targets: + +- Hybrid mobile development using TypeScript(cordova/web/angular) +- Node.js based server +- Fully object oriented approach (classes and interfaces) +- Focus on reusability and developer flexibility +- All modules in single repository, multiple choice for user interfaces as separate repositories +- Comprehensive documentation +- Incorporates only open-source technologies + +## Getting Started + +To run demo application please follow instructions from +our [Reference User Interface](https://github.com/feedhenry-raincatcher/raincatcher-angularjs) repository. + +## Developing core components -RainCatcher supports and is tested on Node.JS@4 and should run on latest LTS. +RainCatcher supports and is tested on node v 6.x LTS. Check your Node.JS version running `node -v` @@ -17,9 +42,8 @@ Check your Node.JS version running `node -v` ```bash git clone https://github.com/feedhenry-raincatcher/raincatcher-core.git cd raincatcher-core -npm install -g lerna npm install -lerna bootstrap +npm run bootstrap ``` ## Repository folder structure diff --git a/img/logo-blue.png b/img/logo-blue.png new file mode 100644 index 0000000..67623f4 Binary files /dev/null and b/img/logo-blue.png differ diff --git a/img/raincatcher.svg b/img/raincatcher.svg new file mode 100644 index 0000000..9b6a4b3 --- /dev/null +++ b/img/raincatcher.svg @@ -0,0 +1 @@ + \ No newline at end of file