| 1 | # joola.io.engine
|
| 2 | Part of the [logger.io framework][14], the open-source data visualization framework.
|
| 3 |
|
| 4 | [![Build Status][3]][4] [![dependency status][5]][6] [![dev dependency status][7]][8] [![Coverage Status][1]][2]
|
| 5 |
|
| 6 | [](https://nodei.co/npm/joola.io.engine/)
|
| 7 |
|
| 8 | ## Overview
|
| 9 | [joola.io][22] is a distributed data processing and visualization framework. The framework is designed as an end-to-end
|
| 10 | solution for data analytics. The framework connects to your databases and using a JSON based mapping of dimensions and
|
| 11 | metrics, it exposes a RESTful API for querying the data. The Client SDK communicates with the engine to display,
|
| 12 | visualize and provide insight into the data. Developers can extend the framework in many ways, add data connectors,
|
| 13 | authentication plugins, visualizations and more.
|
| 14 |
|
| 15 | To learn more about the framework architecture, see our [documentation site][1].
|
| 16 |
|
| 17 | ## The Engine
|
| 18 | joola.io.engine provides the framework with its logic and data processes. It is the core of the framework.
|
| 19 | In a standard deployment, the engine will be used by [joola.io.analytics][10] to query data and visualize it using [joola.io.sdk][11].
|
| 20 |
|
| 21 | Caching is an important part of the framework, it allows joola.io to reply to queries in split seconds, this is also managed by the engine.
|
| 22 | Configuring the engine is not a difficulat task, but it requires understanding of the system, here's good place to start learning about [configuration][26].
|
| 23 |
|
| 24 | A good place to learn more about the Engine, is our [docs][32].
|
| 25 |
|
| 26 | ### Installing
|
| 27 | ```bash
|
| 28 | $ npm install joola.io.engine
|
| 29 | ```
|
| 30 |
|
| 31 | #### Using
|
| 32 | ```bash
|
| 33 | $ npm start
|
| 34 |
|
| 35 | # point your browser to http://localhost:40004
|
| 36 | # and you'll be answered by the REST API.
|
| 37 | ```
|
| 38 |
|
| 39 | ## Bug Reports
|
| 40 | We use [JIRA][17] as our issue tracker and project management tool.
|
| 41 |
|
| 42 | When submitting bug reports, please make sure you provide as much information as possible, including steps to reproduce.
|
| 43 | Each code commit relating to the ticket, will be marked, including builds and tests, so you'll have full transparency as
|
| 44 | to the status of your issue.
|
| 45 |
|
| 46 | ## Contributing
|
| 47 | We would love to get your help! We have outlined a simple [Contribution Policy][18] to support a transparent and easy merging
|
| 48 | of ideas, code, bug fixes and features.
|
| 49 |
|
| 50 | If you're looking for a place to start, you can always go over the list of [open issues][17], pick one and get started.
|
| 51 | If you're feeling lost or unsure, [just let us know](#Contact).
|
| 52 |
|
| 53 | ## Contact
|
| 54 | Contacting us is easy, ping us on one of these:
|
| 55 | - [@joolaio][19]
|
| 56 | - [info@joo.la][20]
|
| 57 | - #joola.io on irc.freenode.net
|
| 58 | - You can even fill out a [form][21].
|
| 59 |
|
| 60 | ## License
|
| 61 | Copyright (c) 2012-2013 Joola Smart Solutions. GPLv3 Licensed, see [LICENSE][24] for details.
|
| 62 |
|
| 63 |
|
| 64 | [1]: https://coveralls.io/repos/joola/joola.io.engine/badge.png
|
| 65 | [2]: https://coveralls.io/r/joola/joola.io.engine
|
| 66 | [3]: https://travis-ci.org/joola/joola.io.engine.png
|
| 67 | [4]: https://travis-ci.org/joola/joola.io.engine
|
| 68 | [5]: https://david-dm.org/joola/joola.io.engine.png
|
| 69 | [6]: https://david-dm.org/joola/joola.io.engine
|
| 70 | [7]: https://david-dm.org/joola/joola.io.engine/dev-status.png
|
| 71 | [8]: https://david-dm.org/joola/joola.io.engine#info=devDependencies
|
| 72 | [9]: https://github.com/joola/joola.io.engine
|
| 73 | [10]: https://github.com/joola/joola.io.analytics
|
| 74 | [11]: https://github.com/joola/joola.io.sdk
|
| 75 | [12]: https://github.com/joola/joola.io.config
|
| 76 | [13]: https://github.com/joola/joola.io.logger
|
| 77 | [14]: https://github.com/joola/joola.io
|
| 78 | [15]: http://nodejs.org
|
| 79 | [16]: http://serverfault.com/
|
| 80 | [17]: http://https://joolatech.atlassian.net/browse/JARVIS
|
| 81 | [18]: https://github.com/joola/joola.io/blob/master/CONTRIBUTING.md
|
| 82 | [19]: http://twitter.com/joolaio
|
| 83 | [20]: mailto://info@joo.la
|
| 84 | [21]: http://joo.la/#contact
|
| 85 | [22]: http://joola.io/
|
| 86 | [23]: http://ci.joo.la
|
| 87 | [24]: https://github.com/joola/joola.io.config/blob/master/LICENSE.md
|
| 88 | [25]: https://joolatech.atlassian.net/wiki/display/JAD/Welcome
|
| 89 | [26]: https://joolatech.atlassian.net/wiki/display/JAD/Getting+Started
|
| 90 | [27]: https://joolatech.atlassian.net/wiki/display/JAD/Installing+joola.io
|
| 91 | [28]: https://joolatech.atlassian.net/wiki/display/JAD/Developers
|
| 92 | [29]: https://joolatech.atlassian.net/wiki/display/JAD/Developers/Coding+Guidelines
|
| 93 | [30]: http://github.com/itayw/nconf-http
|
| 94 | [31]: http://expressjs.com/
|
| 95 | [32]: https://joolatech.atlassian.net/wiki/display/JAD/WebService+API
|
| 96 |
|
| 97 | [](https://bitdeli.com/free "Bitdeli Badge")
|
| 98 |
|