Shared Components for MindPrint Learning 2.0

This repo is for creating a library of components that are shared across V2 MindPrint react projects. The overarching process for creating or modifying a component is to develop with Storybook and publish to NPM.

For a tutorial on using Storybook to publish a React Comopnent Library to npm, see Build and Publish a React Compoonent Library.

Storybook

Storybook is "an open source tool for building UI components and pages in isolation. It streamlines UI development, testing, and documentation."

To run Storybook and edit components use: npm run storybook. Storybook viewer, live reload, etc. can then be found at http://localhost:6006/.

NPM Modules

To use these components in another project, add "@mindprint-learning/mindprint-components": "latest" to your package.json and yarn (or npm install). You can also run npm install @mindprint-learning/mindprint-components. Be sure to verify that you have the latest version if you are testing comoponent changes in another project.

To publish, follow these steps:

• Create an NPM account (if you don't have one already)
• Get added to the MindPrint organization by Luke.
• cd to this project locally, and run npm login (and follow the prompts to enter your username and password)
• Bump the revision number in the package.json file.
• Run npm run build to create a new version of the package.
• Run npm publish --access public to publish the latest version.
• Find the published library here.

TODO

• Make repo private and document any changes to publishing process.
• Add design document to explain when to make a shared component and how it should look.