This package has been deprecated

Author message:

this is not the repository you are looking for, you should use 'generator-react-exhibit' instead

react-exhibit-boilerplate

1.1.0 • Public • Published

exhibit banner License npm

react-exhibit-boilerplate

A boilerplate to create your own React component library, built with create-react-app. Uses the react-exhibit components for visualization.

You can view it in action here.

Using the boilerplate

Clone the repository

git clone https://github.com/au-re/react-exhibit-boilerplate.git
cd react-exhibit-boilerplate

Change the package.json and README.md information.

Displaying your components

You can add a demo folder in a components folder. In this folder you can add as many demos as you want. Each demo file will automatically be rendered and the source displayed.

In addition you can comment your code using JSDOC syntax. This information will then also be displayed in the documentation.

e.g.

/**
 * A showcase component, renders a react component and displays source code.
 *
 * @export
 * @param {string} demo - the react demo to be run
 * @param {string} source - the source code to be displayed
 * @return {object} Showcase Component
 */
const Showcase = ({ source, demo }) => ( ... );

NOTE:

Only comments with the @export tag will be shown in the documentation. Only comments of a component with a demo will be shown.

To view your component documentation run:

npm start

Building your components

You can create a production ready website for your documentation with:

npm run build

You can build your library with:

npm run build:dist

After running this command your library will be found in the dist folder.

Make sure you export your components from index.js. Only the components exported here will be part of your library.

Testing your components

Before publishing or commiting your components, the linter and tests will automatically run. You can also run them manually with:

npm run test

Publishing your library

You can easily deploy your library documentation to github pages. To do that, add the field homepage: <YOUR_GITHUB_PAGE_URL> to package.json.

Then run:

npm run deploy

You can publish your library to npm. To do that, simply run:

npm publish

Readme

Keywords

none

Package Sidebar

Install

npm i react-exhibit-boilerplate

Weekly Downloads

1

Version

1.1.0

License

MIT

Last publish

Collaborators

  • au-re