dave/eveship.fit.react
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: update README with instructions how to start development (#114)

Browse Source
This commit is contained in:
Patric Stout
2024-05-12 12:24:27 +02:00
committed by GitHub
parent f5aff61ada
commit 83f1aa211f
1 changed files with 27 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@@ -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.