Skip to content

Latest commit

 

History

History
45 lines (32 loc) · 1.95 KB

README.md

File metadata and controls

45 lines (32 loc) · 1.95 KB

React Boilerplate

A super simple way to start using React.

Dependencies Status Code Style

Why use it?

This boilerplate provides the whole tooling you need to start a new React application: Webpack, Babel and a dev server. It also includes ESLint and Sass and it's production-ready!

Install

$ git clone https://github.com/cesarcosta99/react-boilerplate
$ npm install
$ npm start

Tip: you can use Yarn to install dependencies faster!

After npm start the project will be running at http://localhost:8080.

Build

The build results in three main files: index.html, app.bundle.js and main.min.css:

$ npm run build

Guidelines

Below there are some instructions about the tooling:

Styleguide

Since there is Babel in the tooling, ES2015 is supported, and by default, ESLint is checking for standard style. You can change this by editing .eslintrc.js.

Dashboard

You can look for any useful information, like what's happening with your build, when you perform npm start since it's running webpack-dashboard.

Sass

Since sass-loader it's using sass/libsass and it does not provide url rewriting, all linked assets must be relative to the output.

Tooling

Contributing

I'll love any kind of contribution you can provide, feel free to do it.

License

Licensed under the MIT License.