amaze-ui-library

Introduction

Welcome to amaze-ui-library, Amaze's react-based component library

amaze-ui-library is a collection of commonly used react based UI components, as well as a series of helper SCSS classes and utility functions. These components are fully responsive, fully accessible, and fully tested. The goal for this library is to provide simple, modular and accessible components that provides all the building blocks we need to build our React applications, as well as to act as exhaustive documentation for how we approach front-end projects at Amaze.

How to install

amaze-ui-library is a private npm module. In order to install this module, you'll need to have an npm account that is added to the teespring organization, and then you'll need to login to that npm account using the npm cli.

Steps:

1. If you don't already have one, create an npm account. https://www.npmjs.com/
2. Make sure you are added to teespring's npm organization
3. In your command line, enter the following command and login using your npm account credentials:

npm login

This will allow you to install the amaze-ui-library package:

yarn

yarn add amaze-ui-library

npm

npm install --save amaze-ui-library

The component library will be available as amaze-ui-library in your app.

import { Button } from 'amaze-ui-library';