React Base Components

Description

This library is intended to speed up development by providing common UI components that can be used in multiple projects, while remaining unopinionated on styling and code structure.

Adding to existing project

1. yarn add @mdxprograms/react-base

# In your component add the following depending on the components you need and that are available
import { Button } from "@mdxprograms/react-base"

Developing locally

Install dependencies for both the test app and the library @NOTE: This process also runs yarn run linksandbox to enable the sandbox app to update during changes to the react-base components

yarn run install:all

Start up both servers and develop away!

yarn start

Build lib

yarn run build

Running the linter

You can run the linter either in a separate terminal tab while developing or as a one-off with the following commands

# run one-of instance
yarn run lint

# run in parallel to dev server running in a separate terminal window
yarn run lint:watch

npm link command

This command will link the react-base and sandbox setups

yarn run linksandbox

Running the test suite

@TODO: needs implemented

How to contribute

1. Check issues are or create a new issue based on particular needs
2. Create branch with issue number in branch name, ie: add-ci-checks-2
3. Assign PR to any of the contributors added to the repo for review.
4. Once PR is approved, the reviewer can then run then merge into master and publish to npm

Publishing to NPM

@TODO: Add details after travisci quality checks are implemented

Currently the process involves running npm version {major|minor|patch} then npm publish npm publish will run the prepublish script in package.json which ultimately runs a build of lib and then pushes to npm registry.