diff --git a/README.md b/README.md index 63c22b0..6d15fa7 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,33 @@ # React Component library for EVEShip.fit -This repository contains all the components used to build [EVEShip.fit](https://eveship.fit). +This repository contains all the [React](https://react.dev/) components used to build [EVEShip.fit](https://eveship.fit). -## Components +## Development + +Make sure you are authentication against the GitHub NPM. +See [here](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#authenticating-to-github-packages) for instructions. + +```bash +npm install +npm run dev +``` + +This will start a Storybook server, which allows you to view each component and interact with it. +It will reload automatically on changes to the code. + +### Linting and coding style + +Each Pull Request is validated by eslint and prettier. +To run this locally: + +```bash +npm run lint +npm run prettier +``` + +The last command will modify source files where needed. + +## Preview Via [Storybook](https://react.eveship.fit) you can view all the components, their description, and how to use them.