/UXAspects

Enterprise Big Data UX Framework

Primary LanguageJavaScriptApache License 2.0Apache-2.0

UX Aspects

UX Aspects is an open source user interface framework for building modern, responsive, mobile big data applications on the web.

Installation

NPM

  1. Install Node.js, which provides the npm package manager.
  2. Install the UX Aspects package:
npm install @ux-aspects/ux-aspects --save

Bower

  1. Install Node.js, which provides the npm package manager.
  2. Install TypeScript:
npm install typescript --save-dev
  1. Install Angular and other dependencies:
npm install @angular/common @angular/compiler @angular/compiler-cli @angular/core @angular/forms @angular/http @angular/platform-browser @angular/platform-browser-dynamic @angular/platform-server @angular/router ngx-bootstrap chart.js ng2-charts @types/chart.js core-js zone.js rxjs --save
  1. Install Bower:
npm install -g bower
  1. Install the UX Aspects bower package:
bower install ux-aspects

Documentation and Examples

See the documentation site for full details and interactive examples of UX Aspects components:

https://uxaspects.github.io/UXAspects/

Contributing

Pull requests are welcome; see the developer guide for more information.

To build the project, which includes UX Aspects and the documentation site:

  1. Clone the respository:
git clone https://github.com/UXAspects/UXAspects.git
  1. Install the dependencies using npm in the repository directory:
npm install
  1. Build the Iconset using grunt in the repository directory:
grunt iconset
  1. Build the project and start the development server. This will automatically rebuild when source changes are made.
npm start
  1. The documentation site is hosted at http://localhost:8080/. This will automatically reload when changes are made.

License

UX Aspects code is released under the Apache 2.0 License. Licenses for 3rd party code included in this repository can be found in the licenses summary.