ud-react-ui

Table of Contents

1. Getting Started
   • Prerequisites
   • Installation
2. Usage
3. Contributing
4. License

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

The best way to consume UD component is via the npm package which you can install with npm.

npm install ud-react-ui

Importing CSS

Import CSS in the src/index.js file:

import 'ud-react-ui/dist/style.css';

Importing Components

import { Button } from 'ud-react-ui';

(back to top)

Usage

See how we implement the component using create-react-app here.

For more examples, please refer to the Documentation

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feat/amazing-feature)
3. Commit your Changes (git commit -m 'Add some amazing-feature')
4. Push to the Branch (git push origin feat/amazing-feature)
5. Open a Pull Request

(back to top)

License

Distributed under the GPLv3 License. See LICENSE.md for more information.

(back to top)

Issues

Duplicate react dependency (local development only)

Assuming myapp and ud-react-ui are sibling folders, one possible fix is to run this command:

npm link ../<myapp-folder>/node_modules/react

More info regarding this issue here.