Installation

Install the componenet library & it's needed dependancies:

npm install roar-component-library --save

yarn add roar-component-library --save

In order to develop on the plugins - clone the repository:

git clone [email protected]:roardigital/roar-component-library.git

Usage

React componenets can be imported via:

import {COMPONENT_NAME} from "roar-component-library".

Components

There are currently ~~one~~ ~~two~~ ~~three~~ four components, a form, a table, a modal and a flash message component .

Up to date docs can be found in the README.md file in the directories of the components in /src & are also linked above.

Developing the components

Clone the repository linked above.

|--/dist `don't edit, this is the transpiled version of the code you use when importing`
|--/examples 
|----/src
|------/components `again, don't edit`
|------/pages`play around with components without making a new project`
|--/node_modules `dev dependencies`
|--/src `edit the actual components in here`
|--/test `write tests in here`

Useful scripts:

npm publish: Publishes the package to the NPM repository.

npm run test: Runs the test runner in silent mode

npm run prepublishOnly: Not usually required. Compiles the contents of /src into /dist. This however is done automatically whenever npm publish is run, so no need to run this manually.

npm run compileExamples: Watches for changes in /src & transpiles the files to /examples/src. This means that any changes in the code in /src will be reflected in the examples.

npm run startExamples: Starts the developement server in /examples.

npm run develop: Runs npm run startExamples & npm run compileExamples at the same time. This will mean that a server will listen on localhost:3001 & any changes in the root /src folder will transpile to the /examples/src folder. Therefore the components can be edited and the results seen live.