README.md

AmeelioUI

The UI component framework for Ameelio: a non-profit technology company committed to transforming prison communications.

Using AmeelioUI

You can consume this component library in your own project.

Installing

Install AmeelioUI as a dependency

npm install --save ameelioui

Base CSS

In your app, import ameelioui/dist/css/custom.css.

Components

Documentation for all components can be viewed in the hosted style guide.

Individual components can be imported individualy. For example:

import Button from 'ameelioui/dist/components/Button';

You can then use this Button component:

<Button variant="secondary">Click me</Button>

Development

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

• Install Node.js
• Install npm

Installing

Install Project Dependencies

To install dependencies run

npm install

Starting the Project

To start the local development server run

npm start

This runs the interactive component style guide.
Open http://localhost:6060/ to view it in the browser.

Running the tests

Run unit tests

npm test

Deployment

To generate a production style guide build run

npm run build

Builds the style guide assets for deployment to the build/docs folder. Merges to master are automatically deployed to GitHub Pages.

Releasing a new version

To release a new version of AmeelioUI, do the following to create a release branch. Replace version_type with major, minor or patch as appropriate, based on SemVer:-

git checkout -b your-release-branch
npm version version_type -m "Release version %s"
git push
git push --tags

This will add a commit that updates package.json and package-lock.json with the updated version number.

Once this branch's PR is merged to master, do the following to publish the release so it can be consumed from npm:-

# requires an npm user with permissions to release
git checkout master
git pull
npm install
npm run build
npm publish

Built With

• React - The web framework used
• Create React App - Project bootstrapping
• React Styleguidist - Interactive style guide
• React-Bootstrap - Base component library

Contributing

Please read CODE_OF_CONDUCT.md for details on our code of conduct, and CONTRIBUTING.md for the process for submitting pull requests to us.

Authors

See the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details