README.md

Welcome to maj-ui

maj-ui is a React-based UI toolkit for the web.
This page describes how to get started building an application with maj-ui.

Documentation.

You can find the doc here

Installation

Install it with package manager npm or yarn (Yarn is used in this example):

  yarn add maj-ui

Then, you need to add a css file to your entry point file: (src/index.tsx or src/index.jsx)

import 'maj-ui/dist/index.css';

Usage

Using Button component form package.

import { Button } from 'maj-ui';

const IncrementButton = () => {
  return (
    <Button
      label="increment"
      startIcon={props => <Plus {...props} />}
      appearence="primary"
      onClick={onIncrement}
    />
  );
};

Run the project on your machine

Clone the repository

 git clone [email protected]:Mario-aj/maj-ui.git
 cd maj-ui

Installing dependencies

 yarn

Run the project

 yarn dev

You can check that it worked by browsing http://localhost:6006/.

Deployment

Merging to the main branch will automatically deploy to github pages.

Contributing

I'd love to have your helping hand on maj-react-ui! See CONTRIBUTING.md for more information on how to get started.

License

maj-ui is MIT licensed

✍🏻 Creator

Mário Alfredo Jorge