Crew 2ls

A collection of react components, hooks and other utilities used in various Crew 2 projects

Getting it running

Upon pulling down the repo, in order to get the component browser running, all you need to do is run npm install in the root, and then run npm run ladle once that's done. This should provide you with a link to a site containing a list of all the components available in crew-2ls.

Adding your own component

1. Copy/paste in component from IRC project
2. Add a story that gives a basic demonstration of your component. Check out the ladle documentation on how to create stories
3. Add jsDocs comments (/** */) to your components props, indicating what each one does as well as any default behaviors for optional props (just so downstream users know what does what)
4. Export your component from src/index.ts (which is what actually adds your component to the final built npm package)

Building and Publishing

You can build the project using npm run build to see what the final npm package looks like. Unfortunately though, deploying currently can only be done by Nick MacDonald until the package is moved under the @torqit scope