Chartieer / react_typescript_cra_storybook_sketch

React Typescript, SCSS, CSS Modules, Storybook, Sketch exporter starter project

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

React Storybook - Typescript

Build Status codecov code style: prettier Commitizen friendly

This is a storybook starter project template that supports typescript.

The project supports the following technologies:

Development

  1. Install NodeJS using brew on a Mac or from the official website and setup your environment.
  2. Run brew install yarn to install yarn.
  3. Run yarn install from the project's root directory to install the dependencies.
  4. Run yarn start and start hacking your project.

Production

  1. Run yarn build to build your project.
  2. Deploy your build folder to a server that supports node to share your storybook.

License

Copyright (c) 2018 LEVIOZA

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

React Typescript, SCSS, CSS Modules, Storybook, Sketch exporter starter project


Languages

Language:CSS 43.1%Language:JavaScript 40.7%Language:TypeScript 16.2%