Added a README for development setup
Project: http://git-wip-us.apache.org/repos/asf/incubator-blur/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-blur/commit/d2f498bf Tree: http://git-wip-us.apache.org/repos/asf/incubator-blur/tree/d2f498bf Diff: http://git-wip-us.apache.org/repos/asf/incubator-blur/diff/d2f498bf Branch: refs/heads/apache-blur-0.2 Commit: d2f498bf503ea3e0f2016f023edbb97b2cb901b7 Parents: f27fbe1 Author: Chris Rohr <[email protected]> Authored: Sun Mar 30 22:22:50 2014 -0400 Committer: Chris Rohr <[email protected]> Committed: Sun Mar 30 22:22:50 2014 -0400 ---------------------------------------------------------------------- contrib/blur-console/README.md | 58 +++++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/d2f498bf/contrib/blur-console/README.md ---------------------------------------------------------------------- diff --git a/contrib/blur-console/README.md b/contrib/blur-console/README.md new file mode 100644 index 0000000..6b6d39e --- /dev/null +++ b/contrib/blur-console/README.md @@ -0,0 +1,58 @@ + +# Blur Console + +Blur Console is a tool built to help visualize that status of an Apache Blur (Incubator) cluster. The tool contains information about node status, table status, and query status. The tool also has a built in search page to quickly search and retrieve records and rows from Apache Blur. + +## Development Setup + +The development for this tool is done in two pieces the UI (Javascript) and the services (Java). The services piece contains and encapsulates all of the connections and requests into Apache Blur. The services piece is also responsible for starting a webserver and serving the static UI resources. The structure of this component allows for the UI and services to be worked on independently and then both can be packaged together for one distribution. + +In order to contribute to the development of this component the following tools/languages will need to be available: + +* Java +* Ruby (1.9.x or higher) +* Node (0.10.x or higher) - This will come with npm + +### UI Development + +The UI code lives in the ui directory. This directory has been setup like a standard javascript based application would be. The goal of this is to allow for rapid development of the UI components while flushing out the service API. The UI portion has been built so that the system can be run with fake data to mock out the actual Apache Blur integration. + +To get up and running to work on the UI component you can follow these steps: + +1. Install bower (js package manager) + + npm install -g bower + +2. Install grunt-cli (node build manager) + + npm install -g grunt-cli + +3. Install compass (this will install sass a stylesheet compiler) + + gem install compass + +4. Install project build/test dependencies (from the ui directory) + + npm install + +5. Install js dependencies (from the ui directory) + + bower install + +Once the dependencies and build tools are installed the following commands can be used (from the ui directory): + +* Run tests + + grunt test + +* Start development server (server will be available on port 9000) + + grunt serve + +### Services Development + +The services code lives at the root of the console directory and is a basic maven project. + +## Packing for distribution + +TODO: Need to still figure this out \ No newline at end of file
