Skip to content

dev-guy/react-toolbox-reactrouter-mocha-boilerplate

 
 

Repository files navigation

A minimal Starter Kit for Modern React Web Applications

Visit the Live demo

See Also

Supported Platforms

This project will only work on Unix-like systems like OSX and Linux. In other words, it will not work on Windows because:

  1. add-path, which is optional, is a shell script
  2. sass-lint doesn't have a Webpack loader so I had to improvise something that uses find
  3. Some of the scripts in project.json use && to run multiple commands
  4. fsevents, which is a dependency of an unknown module, doesn't run on Windows. It's possible that this is no longer an issue.

Getting Started

  1. Clone this repository
  2. npm install

Development

Prepare your command line environment (optional)

  • source add-path

add-path adds the node_modules/.bin directory to your PATH so you can run commands like 'eslint' from the command line. "npm run" does this for you.

lint your js files

  • npm run eslint (eslint, unlike sass-lint, is run automatically by Webpack)

lint your sass files

  • npm run sass-lint (eslint, unlike sass-lint, is run automatically by Webpack)

lint everything

  • npm run lint

Run tests

  • npm test

Run the app

  1. npm start
  2. Visit http://localhost:8080 in your browser

Production

  1. npm run build (this also runs lint)
  2. Copy the file www/index.html to your web server
  3. Copy the files in the 'build' directory to your web server in the same directory where index.html is located

About

A minimal starter kit for modern React web application development

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 87.9%
  • HTML 7.0%
  • CSS 5.1%