A React component library for use in my personal projects. This readme is probably bad & I will change it later.
- The package itself is written in TypeScript, uses Rollup as a bundler and Jest for testing.
- The documentation site is powered by Next.js and Nextra.
- Additionally, Prettier and ESLint are included.
Runs both the build:watch
& docs
scripts at once, building the library in watch mode while also running the docs site at http://localhost:3000.
Builds the library to the dist
folder, within the package directory.
Same as build
, but runs in watch mode. This means any change to the source files in src
will trigger a rebuild.
Runs the documentation site at http://localhost:3000. The page will auto-update as you edit files within docs
.
Builds the docs site as static files to the dist
folder within docs
.
Lints all docs files using ESLint.
Formats all files using Prettier.
Lints all packages files using ESLint.
Runs all test in the project.