Skip to content

LucasBassetti/react-airbnb-boilerplate

Repository files navigation

React Airbnb Boilerplate

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

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 for ES6 support.
  • Chai as BDD / TDD assertion library.
  • ESlint for ES6 linting using Airbnb's JS style guide.
  • Mocha as test framework.
  • Nyc as test coverage.
  • React as front-end view library.
  • Webpack as module bundler.
  • SASS as CSS preprocessing.
  • Postcss for transforming styles with JS plugins.

Getting Start

Run the following commands in your terminal

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

Then open 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