Skip to content
This repository has been archived by the owner on Jul 28, 2018. It is now read-only.

donna-marijne/UXAspects-Docs

Repository files navigation

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 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
  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. (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
  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 https://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.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published