README
Nyxo UI library
Credits
This repo was bootstrapped with gatsby-typescript-storybook-starter
Features
- Gatsby MDX for JSX in Markdown loading, parsing, and rendering of pages
- Storybook for isolated component development
- styled-components for CSS-in-JS
- ESLint with Airbnb's config
- Prettier integrated into ESLint
- Typescript integrations and validation
Development
Node.js v8.0.0 or above is required and using Yarn is recommended.
# install dependencies
yarn
# ...or with npm
npm install
# serve with hot reload for development (localhost:8000)
yarn develop
# serve storybook with hot reload for development (localhost:9000)
yarn storybook
# lint project
yarn lint
# format project source
yarn format
# run tests
yarn test
# build for production
yarn build
# build static storybook (outputs to `public/docs` folder)
yarn storybook:build
# serve locally (after building)
yarn serve
# clean the local build
yarn clean
License
This project is licensed under MIT