react-conventions

An open source set of React components that implement Ambassador's Design and UX patterns.

Usage no npm install needed!

<script type="module">
  import reactConventions from 'https://cdn.skypack.dev/react-conventions';
</script>

README

React:ions

Circle CI Status for GetAmbassador/react-conventions

Codacy Badge

React:ions is a suite of React components that implement Ambassador's Design and UX patterns. They are designed to be re-usable and composable across large-scale web applications.

Check out our documentation site for live examples.

Installation

Ambassador's React Conventions is available as an npm package.

$ npm install react-conventions

Run the app:

$ npm start

Point your browser to http://localhost:3000

Usage

Using Ambassador's react components is very straightforward.

import React from 'react'
import Button from 'react-conventions/lib/Button'

const MyComponent = () => (
  <Button />
);

export default MyComponent

License

This project is licensed under the terms of the MIT license

Release Process

  1. Checkout / pull latest master branch
  2. Create a new branch (named like release_v0_0_5)
  3. Run: $ npm run build:release
  4. Run: $ npm version <semantic_version> (ex: 0.57.0)
  5. Edit CHANGELOG.md to reflect changes since last release
  6. Ping someone to review CHANGELOG.md
  7. Create a pull request for this branch
  8. Merge pull request
  9. Create release on Github
  10. Run: $ npm publish
  11. Ensure new version is published: https://npmjs.com/react-conventions