Skip to content

Latest commit

 

History

History
95 lines (64 loc) · 2.41 KB

CONTRIBUTE.md

File metadata and controls

95 lines (64 loc) · 2.41 KB
Raw

platypusui

This library contains the Platypi UI framework, PlatypusUI. It is built on top of PlatypusTS.

Dependencies

PlatypusUI depends on PlatypusTS

Development Dependencies

While developing, ensure that NodeJS is installed.

Platform support

PlatypusUI is designed for use in a browser only. It works in all evergreen browsers (IE >= 10)

Documentation

Find all the documentation on PlatypusUI here

Building the Code

To build the code take the following steps:

  1. From the root project folder run:
npm install
  1. Run the following task:
npm run build-all

Building for Deployment

To build a deployment package of PlatypusUI take the following steps:

  1. Ensure that Grunt is installed. If you need to install it you can use the following command:
npm install grunt -g
  1. Run the following command:
grunt
  1. You will find the compiled package in the dist directory.

Building for Documentation Output

PlatypusUI is heavily documented using JSDoc format. However, for distribution many of the comments are stripped out in order to make them easier to read in various IDEs. To get a build of PlatypusUI with full documentation take the following steps:

  1. Ensure that Grunt is installed. If you need to install it you can use the following command:
npm install grunt -g
  1. Run the following command:
grunt docs
  1. You will find the compiled file in the dist directory.

Developing the Code

While developing the code, there are a few useful npm scripts:

  1. watch-examples: Builds and watches the examples directory
  2. watch-src: Builds and watches the src directory

Run any of these scripts with the following command:

npm run <script>

Using the Examples

The examples directory is a playground for quickly testing functionality. You can run the examples using the following command:

npm run examples

This will open a server in the examples directory running on port 3000. You can then open you browser to http://localhost:3000/examples to use the examples.

Cleaning the Build

To clean all the built-files execute the following command:

npm run clean-all

NOTE: More tasks can be found in the package.json