djizco / react-boilerplate Goto Github PK

View Code? Open in Web Editor NEW

A Simple React Boilerplate for Web Apps. Uses React, Redux, Webpack, Hot Reloading for JS and CSS, Testing, and more.

License: MIT License

JavaScript 92.24% HTML 0.71% SCSS 6.51% Shell 0.53%

react-boilerplate's Introduction

React Boilerplate

You can try out this project here

Requirements

Operating System: MacOS or Linux
Node.js (I recommend installing with NVM)

Quick Start

Setup

npm install

for Development

npm start

for Production

npm install -g serve

npm run build
npm run serve

for Deployment (using surge)

npm install -g surge

npm run build
npm run deploy
# You may have to create an account

Other Commands

npm test
npm run test:watch
npm run test:verbose
npm run test:coverage
npm run lint
npm run lint:fix

Setup Instructions

To setup your own project, you will need to copy the contents of this project into a new repo. You will need to update the content in these files to names of your project and yourself:

package.json: name, version, description, repository, author, bugs, homepage
LICENSE: (update to your preferred license)
client/index.html: description and title
this README.md

This is also a good time to go through the included libraries to add or remove features that you want.

After this you can commit the files into a new repository and push up to your github. You can now start updating files in your client to begin working on your own project!

Features

Webpack conveniently bundles your code for you.
Babel lets you use ES6/7 features.
CSS pre-processor setup for LESS and SASS lets you keep your styles clean and organized.
ESLint helps you maintain a high level of code quality.
Jest gives you a robust testing frame work to make sure your code works.

Code Structure

- config
- scripts
- client
  - assets
    - images
    - icons
  - components
    - pages
    - environment
  - hooks
  - store
    - actions
    - reducers
    - thunks
    - tests
  - styles
  - utils