UX Aspects is an open source user interface framework for building modern, responsive, mobile big data applications on the web.
- Install Node.js, which provides the npm package manager.
- Install the UX Aspects package:
npm install @ux-aspects/ux-aspects --save
- Install Node.js, which provides the npm package manager.
- Install TypeScript:
npm install typescript --save-dev
- Install Angular 4 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
- Install Bower:
npm install -g bower
- Install the UX Aspects bower package:
bower install ux-aspects
See the documentation site for full details and interactive examples of UX Aspects components:
https://uxaspects.github.io/UXAspects/
Pull requests are welcome; see the developer guide for more information.
To build the project, which includes UX Aspects and the documentation site:
- Clone the respository:
git clone https://github.com/UXAspects/UXAspects.git
- Install the dependencies using
npm
in the repository directory:
npm install
- (Optional) Add the webpack-dev-server certificate (
node_modules/webpack-dev-server/ssl/server.pem
) to the machine's certificate store. This will allow the development server to run using HTTPS without warnings, which is required to test Plunker/CodePen examples locally. On Windows, with OpenSSL installed:
grunt webpack_import_cert
- Build the project and start the development server. This will automatically rebuild when source changes are made.
npm start
- The documentation site is hosted at https://localhost:8080/. This will automatically reload when changes are made.
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.