README
@codotype/ui
:desktop_computer: Codotype UI components - built with React + Typescript
Getting Started
Run the following commands to install dependencies and start developing
yarn install
yarn storybook
Scripts
yarn dev
- runwebpack
inwatch
modeyarn storybook
- runs the Storybook serveryarn build
- builds the NPM packageyarn test -u
- runs Jest + updates test snapshotsyarn lint
- runs EsLintyarn prettify
- runs Prettier
Notes
Includes ESLint configured to work with TypeScript and Prettier.
Includes tests with Jest - note that the
babel.config.js
and associated dependencies are only necessary for Jest to work with TypeScript.Recommended to use
Visual Studio Code
with theFormat on Save
setting turned on.Includes Storybook configured to work with React + TypeScript. Note that it maintains its own
webpack.config.js
andtsconfig.json
files. See example story insrc/**/__tests__/*.stories.tsx
Built with
Misc. References