# 🦾 React boilerplate

Highly customizable React boilerplate built with webpack.

[![License: WTFPL](https://img.shields.io/badge/License-WTFPL-brightgreen.svg)](http://www.wtfpl.net/about/) [![Netlify Status](https://api.netlify.com/api/v1/badges/69520b70-de4a-4925-940f-086b6294d128/deploy-status)](https://app.netlify.com/sites/imklau-react-boilerplate/deploys)

<img src=https://imklau-react-boilerplate.netlify.app/48f5571443be16102133704a370b058c.jpg height="250px">

## 🚀 Quick start

Make sure you have node +14 and npm +7 installed, then run:

```
npx @imklau/react-boilerplate <app-name>
```

If you want to create a **React & TypeScript** app use the `-ts` flag:

```
npx @imklau/react-boilerplate <app-name> -ts
```

## 👩🏻‍💻 Available commands:

- `yarn start` - runs the app in the development mode. (`localhost:9000` by default)
- `yarn build` - builds the app for production, files are saved to the `public` folder
- `yarn lint` - runs eslint to check all your `.js` / `.ts` files in the `src` directory
- `yarn format` - runs prettier to format all your `.js` / `.ts` files in the `src` directory

## 📃 License

This project is available under the WTFPL license.
