Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lucasbassetti/react-airbnb-boilerplate

:fire: React Boilerplate following Airbnb's JavaScript (ES6) Style Guide
https://github.com/lucasbassetti/react-airbnb-boilerplate

airbnb airbnb-javascript boilerplate chai eslint javascript mocha postcss react sass started webpack

Last synced: 4 days ago
JSON representation

:fire: React Boilerplate following Airbnb's JavaScript (ES6) Style Guide

Awesome Lists containing this project

README

        

# React Airbnb Boilerplate

React Boilerplate following [Airbnb's JavaScript (ES6) Style Guide](https://github.com/airbnb/javascript).






## Features

- Simple `index.html` loading `bundle.js`.
- Starter `index.jsx` for React.
- All code following Airbnb's JavaScript (ES6) style guide with ESlint.
- Webpack dev server with automatic reloading. Start with: `npm start`.
- Deployment build with `npm run build`.

## Components

- [Babel](https://babeljs.io) for ES6 support.
- [Chai](http://chaijs.com/) as BDD / TDD assertion library.
- [ESlint](http://eslint.org) for ES6 linting using Airbnb's JS style guide.
- [Mocha](https://mochajs.org/) as test framework.
- [Nyc](https://github.com/istanbuljs/nyc) as test coverage.
- [React](https://facebook.github.io/react/) as front-end view library.
- [Webpack](https://webpack.github.io) as module bundler.
- [SASS](http://sass-lang.com/) as CSS preprocessing.
- [Postcss](http://postcss.org/) for transforming styles with JS plugins.

## Getting Start

Run the following commands in your terminal

```bash
git clone https://github.com/LucasBassetti/react-airbnb-boilerplate.git
cd react-airbnb-boilerplate
npm install
npm start
```

Then open [http://localhost:8080/](http://localhost:8080/) on your web browser.

### Testing

1. Run `npm test` for simple test.
2. Run `npm run test:watch` for watch tests.
3. Run `npm run test:coverage` for test coverage. This will generate a `coverage` folder. Open the `index.html` file in this folder to check the results.

## Deploying

For deployment, run `npm run build` and upload `docs/` to your server.

## License

MIT · [Lucas Bassetti](http://lucasbassetti.com.br)