crux

(โ˜… 100)

Crux is a reporting application for HBase. Crux provides a simple web based graphical interface to access HBase, query data and create reports. Crux is open sourced under Apache Software Foundation License v2.0.

Showing a partial file list โ€” download the zip above to see everything.

  • .ant-targets-build.xml
  • .gitignore
  • assembly.xml
  • CommitterChecklist.txt
  • hibernate.properties
  • LICENSE.txt
  • NOTICE.txt
  • pom.xml
  • README.md

# Installation Guide

1. Get the code
git clone https://github.com/sonalgoyal/crux

Downloads the entire project code from GitHub to your computer.

cd crux

Moves into the project folder you just downloaded.

2. Maven (Java)

Medium Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java projects.
  • Maven The build tool used for the mvn command.
CRUX_HOME$ mvn jetty:run

Installs dependencies and builds the project using Maven.

CRUX_HOME$ mvn -Dcdh4 install

Installs dependencies and builds the project using Maven.

CRUX_HOME$mvn -Dcdh3 install

Installs dependencies and builds the project using Maven.

CRUX_HOME$ mvn test

Installs dependencies and builds the project using Maven.

โœ… A BUILD SUCCESS message means it worked. The output is created under target/.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
โš ๏ธ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd src/main/webapp/js/d3

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

4. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
โš ๏ธ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd src/main/webapp/js/d3

This project's files live in a subfolder, so move into it first.

make

Compiles the code based on the generated build configuration to produce an executable.

โœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation