bigbom-react-ui

Bigbom React UI

---

A set of React components follow the Bigbom Design System

📝 Table of Contents

• About
• Getting Started
• Publish
• Built Using
• TODO
• Contributing
• Authors
• Acknowledgments

🧐 About

Write about 1-2 paragraphs describing the purpose of your project.

🏁 Getting Started

Prerequisites

• NodeJS: >= 8.3.0

Installing

Using components

For using Bigbom React UI Components library, try to install it first

npm install bigbom-react-ui

Then import styles and components

import React from 'react';
import ReactDOM from 'react-dom';
import 'bigbom-react-ui/dist/bigbom-react-ui.css';
import { Text } from 'bigbom-react-ui';

ReactDOM.render(<Text>This is an example</Text>);

For development

npm run dev

For build distribution

npm run build

🔧 Running the tests

We must run all the tests before publishing to NPM

Components Unit-test

npm run test

And coding style tests

npm run lint

🚀 Publish

npm publish

⛏️ Built Using

• React - React
• Rollup - RollupJS
• Styleguidist - React Styleguidist
• Jest - Jest Testing Framework

✍️ Authors

• @nhanhoangtrong - Fullstack Web Developer

See also the list of contributors who participated in this project.

🎉 Acknowledgements

• Hat tip to anyone whose code was used
• Inspiration
• References