Meteorite Core UI

Table of Contents

1. Setup

• Build Instructions
• Run UI on Node.js

2. Documentation
3. Usage
4. Tasks
5. Support

• Browser
• Server

6. Team
7. Contributing
8. History
9. License

Setup

Build Instructions

To install:

mvn clean install

Install Apache Karaf 4.x

feature:install pax-http-whiteboard

bundle:install -s mvn:bi.meteorite/ui/1.0-SNAPSHOT

Bundle will then be available on http://localhost:8181/

Run UI on Node.js

In order to run it locally you'll need a basic server setup.

1. Clone it:

$ git clone git@github.com:OSBI/meteorite-core-ui.git

2. Install NodeJS and GulpJS, if you don't have it yet.

3. Install Dependencies:

$ cd meteorite-core-ui/src/main/resources/ && npm install

4. Serve it:

$ npm run dev

5. Run tasks with Gulp:

$ gulp

6. Run the mock server NodeJS (optional):

$ npm run server

7. Execute tests (optional):

$ npm test

Documentation

Documentation Meteorite Core UI.

Usage

• Run npm run build to build the project;
• Run npm run clean Clean resources folder;
• Run npm run dev to build the project, start watching files and run the local server;
• Run npm run docs to generate the documentation the code;
• Run npm run server to run the mock server NodeJS;
• Run npm test to run the tests once;
• Run npm run test:ci to watch the src directory for changes and run the tests.

Tasks

• gulp: Initialize stylus and watch for changes;
• gulp bower-install: Move dependencies to folder dist/assets/;
• gulp deploy-pages: Deploy documentation files to github on branch gh-pages;
• gulp imagemin: Compress image files;
• gulp stylus: Compile stylus files;
• gulp watch: Call for watch files.

Support

Browser

We do care about it.

						Android	iOS	Windows Phone
Latest ✔	Latest ✔	Latest ✔	Latest ✔	Latest ✔	Latest ✔	4.4+ ✔	7+ ✔	8+ ✔

Server

0.10+ ✔

Team

Meteorite Core UI is maintained by these people and a bunch of awesome contributors.

| | :---: | :---: | :---: | :---: | :---: | :---: | :---: | Tom Barber | Breno Polanski | Bruno Catão |

Contributing

If you want to help, please read the Contributing guide.

History

For detailed changelog, see Releases.

License

Saiku and the Saiku UI are free software. The UI, contained in this repository, is available under the terms of the Apache License Version 2. A copy is attached for your convenience.

⬆ back to top