README.md

@momentum-ui

Momentum UI

Momentum UI is a collection of UI libraries for implementing Momentum Design into web applications and websites.

Table of Contents

• Background
• Usage
• Requirements
• Development
• Contributing
• License

Background

These libraries allow web developers to quickly and easily create Momentum Design web apps and sites. We provide libraries built on HTML/CSS and many of the modern JavaScript frameworks, including ReactJS, Angular and AngularJS. We use a Lerna monorepo to manage all of the libraries in one repository.

Usage

The individual libraries are distributed through npm. You can find information on usage and installation in each of their individual README files.

• @momentum-ui/core
• @momentum-ui/react
• @momentum-ui/icons

Requirements

To contribute to @momentum-ui, you need to have >=Node 8.10.0 and Yarn installed globally on your machine.

Development

Setting up your development environment:

1. Clone this repo using a git client (e.g. git clone https://github.com/momentum-design/momentum-ui.git)
2. Run yarn install from the root of the repo.
3. Run yarn bootstrap from the root of the repo.
4. Run yarn start:all to start the playground app for all libraries or yarn start:<library> to only start the library the you are working in.

Contributing

PRs are welcome! See CONTRIBUTING for details.

License

©2013-2019 Cisco Systems, Inc. and/or its affiliates. All Rights Reserved.

See LICENSE for details.