Arachnae is a simple React component library. It uses Flow for typing and Aphrodite for style management.
A NPM package is hosted on the Github package repository. To install this package:
- Create a Github Personal Access Token, https://github.com/settings/tokens.
- It is recommended you use an access token with only read package access
- Update your
.npmrcfile:- Add your token to authenticate to the Github registry,
//npm.pkg.github.com/:_authToken=TOKEN - Add
@jpbarela:registry=https://npm.pkg.github.com/jpbarela
- Add your token to authenticate to the Github registry,
- You can now use your node package manager to add
@jpbarela/arachnae
The repo also uses a theme extensively. You should wrap the components in a react-jss,
ThemeProvider component. There is a Flow ThemeType exported for type consistence.
Arachanae comes with a (Storybook)[https://storybook.js.org] that can be used for local development or to view the components for use in another project. To start the Storybook simply use
npm run storybook
The primary tests for the repository are Jest tests using the testing-library framework. You can
run the tests with
npm run test