Skip to content

Latest commit

 

History

History
48 lines (31 loc) · 2.02 KB

README.md

File metadata and controls

48 lines (31 loc) · 2.02 KB

react-scripts-aerian-ts

Create React apps (with Typescript) and an opinionated with no build configuration. Based heavily on the excellent create-react-app-typescript.

Get started

npm install -g create-react-app

create-react-app my-app --scripts-version=react-scripts-aerian-ts
cd my-app/
npm start

Where my-app is the name of the application you want to use.

Opinions

These opinions are emplaced by webpack config, npm scripts and our hygen component generator

  • Typescript: we believe typescript helps create well documented, reasonable applications
  • Storybooks: we think storybooks allows component encapsulation and helps reason about styling
  • CSS Modules: we think that, combined with the "3 types of styles" philosphy, this helps with extensibility and encapsulation

Create components

hygen component new --name my-component

# or

hygen component new --class --name my-class-component

This will create all the files for your component; the test, storybook, readme, css module, typings in a folder in src/components

Run Storybooks

npm run storybooks

Changelog

npm version Description Date
0.0.3 1. Removed @types/react as these were conflicting with those in @types/react-dom. 2. Adjusted storybook webpack config and tslint to better deal with storybooks and typescript 2018-06-19
0.0.4 1. Added @types/storybook__react and react-test-renderer with typings 2. Added more to App.tsx 2018-06-19