generator-react

Yeoman generator for React apps.

This generator provides the following features:

• public and src folders as a starter point to build your app.
• EditorConfig to help you define and maintain consistent coding styles between different editors.
• ESLint to provide a pluggable linting utility for JavaScript.
• Airbnb React/JSX style guide.
• Prettier as an opinionated code formatter.
• README.md and CHANGELOG.md with information about the project, installation, usage, development, author and license.
• Badge for License.

Project files

.
|--- public
|    |--- favicon.ico
|    |--- index.html
|    |--- manifest.json
|--- src
     |--- components
          |--- App.jsx
|    |--- index.jsx
|--- .editorconfig
|--- .eslintignore
|--- .eslintrc.json
|--- .gitattributes
|--- .gitignore
|--- .npmrc
|--- .prettierrc
|--- CHANGELOG.md
|--- LICENSE
|--- package.json
|--- README.md

Installation

• Install Yeoman

$ npm install -g yo

• Install Generator

$ npm install -g @robertoachar/generator-react

Usage

• Create an app

# Create a directory for your app
$ mkdir awesome-app

# Change into directory
$ cd awesome-app

# Generate an app
$ yo @robertoachar/react

• Run scripts

| Action | Usage | | --------------------------- | --------------- | | Start development mode | npm start | | Build for production | npm run build | | Lint code | npm run lint | | Run tests | npm run test | | Eject from create-react-app | npm run eject |

Development

Prerequisites

• Install Node.js
• Install npm
• Install Yeoman CLI

$ npm install -g yo

Clone the repo

$ git clone https://github.com/robertoachar/generator-react.git

Run generator

# Change into directory
$ cd generator-react

# Link generator
$ npm link

# Run generator
$ yo @robertoachar/react

Author

Roberto Achar

License

MIT