README.md

create-hotdog-app

Production-ready all-in-one react typescript boilerplate, with Babel 7, Webpack 5, Prettier, ESlint, Stylelint, Commitlint, Lint-staged, and Husky.

Get Started

A Buddhist goes to a hot dog vendor and the vendor asks him "Hey buddy what can I make ya?". "make me one with everything" replies the Buddhist.

yarn

yarn create hotdog-app ./hotdog-app

npx

npx create-hotdog-app ./hotdog-app

folder structure

hotdog-app
├── .husky
│   ├── _
│   │   └── husky.sh
│   ├── .gitignore
│   ├── commit-msg
│   └── pre-commit
├── .vscode
│   ├── extensions.json // recommended VS Code extension
│   └── settings.json // recommended VS Code settings
├── node_modules
├── public
│   ├── favicon.ico
│   ├── index.html
│   ├── logo192.png
│   ├── logo512.png
│   ├── manifest.json
│   └── robots.txt
├── src
│   ├── types
│   │   └── global.d.ts
│   ├── app.less
│   ├── app.tsx
│   └── index.tsx
├── .babelrc
├── .commitlintrc
├── .eslintrc
├── .gitignore
├── .prettierrc
├── .stylelintrc
├── package.json
├── README.md
├── tsconfig.eslint.json
├── tsconfig.json
├── webpack.common.ts
├── webpack.dev.ts
├── webpack.prod.ts
└── yarn.lock

Project Setup

The created hot dog project requires Visual Studio Code and Yarn 1.

VS Code extensions

Open the project with VS Code, and installed the recommended extensions following the pop-up prompt. Alternatively, go to the extension tab on the left and search @recommended, then click Install Workspace Recommended Extensions.

Project Scripts

dev

Start a development server at http://localhost:3000 using Webpack Dev Server

yarn dev

build

Builds the app for production to the dist folder using Babel and Webpack

yarn build