@j154004/generator-react-hot

Yeoman generator to provide the scaffolding for a hot reloading React application

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
11Sep 4, 2020Feb 17, 2018Minified + gzip package size for @j154004/generator-react-hot in KB

Readme

generator-react-hot

Build Status

Yeoman generator to provide the scaffolding for a React app with hot reloading.

Generated app has the following features:

  • Hot reloading for React
  • Transpilation with Babel to support older browsers
  • Linting using ESLint, extending from the airbnb config
  • Dockerfile to spin up an nginx server with built code
  • Jest and Enzyme setup for testing
  • .gitignore file to prevent accidentally pushing unnecessary files
  • Development and production webpack configurations, extending from a base configuration
  • Injects resources into index.html file on build
  • Support for SCSS and CSS for styling

Installation

Install generator-react-hot with npm scoped package:

npm install yo @j154004/generator-react-hot -g

Usage

You can use this generator with yo with ease. In the directory you wish to create your resource run the following command:

yo @j154004/react-hot

Answer the questions asked by the generator, these answers will be injected into various files that will be created in your directory.

All the dependencies required to run the application will be installed automatically.

Options

  • --skip-welcome - Skips welcome greeting before displaying options.

Getting Started

  • Start by running the hot reloading development server with npm start.
  • Navigate to http://localhost:PORT in your browser, where PORT is the one you chose when running the generator. You should see the words "Hello, world!" printed on the page.
  • Change the text inside the <div> element in src/App.js and notice the text change in the browser when you save your changes.

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b feature/new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin feature/new-feature
  5. Submit a pull request.

License

See LICENSE for licensing information.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.