search

bem / create-bem-react-app

[deprecated] Create BEM React apps with no build configuration.
Other
25 stars 8 forks source link

readme

Create BEM React App Build Status

Deprecated in favour of bem-react-boilerplate.

Create BEM React apps with no build configuration.

Create React App works on macOS, Windows, and Linux.
If something doesn’t work please file an issue.

Quick Overview

npm install -g create-bem-react-app

create-bem-react-app my-app
cd my-app/
npm start

Then open http://localhost:3000/ to see your app.
When you’re ready to deploy to production, create a minified bundle with npm run build.

npm start

Get Started Immediately

You don’t need to install or configure tools like Webpack or Babel.
They are preconfigured and hidden so that you can focus on the code.

Just create a project, and you’re good to go.

Getting Started

Installation

Install it once globally:

npm install -g create-bem-react-app

You’ll need to have Node >= 4 on your machine.

We strongly recommend to use Node >= 6 and npm >= 3 for faster installation speed and better disk usage. You can use nvm to easily switch Node versions between different projects.

This tool doesn’t assume a Node backend. The Node installation is only required for the build tools that rely on it locally, such as Webpack and Babel.

Creating an App

To create a new app, run:

create-bem-react-app my-app
cd my-app

It will create a directory called my-app inside the current folder.
Inside that directory, it will generate the initial project structure and install the transitive dependencies:

my-app/
  README.md
  node_modules/
  package.json
  .gitignore
  public/
    favicon.ico
    index.html
  src/
    App/
      Header/
        App-Header.css
        App-Header.js
      Intro/
        App-Intro.css
        App-Intro.js
      App.css
      App.js
      App.test.js
    Page/
      Page.inline.svg
      Page.css
    index.js

No configuration or complicated folder structures, just the files you need to build your app.
Once the installation is done, you can run some commands inside the project folder:

npm start or yarn start

Runs the app in development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will see the build errors and lint warnings in the console.

Build errors

npm test or yarn test

Runs the test watcher in an interactive mode.
By default, runs tests related to files changes since the last commit.

Read more about testing.

npm run build or yarn build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

What’s changed?

Currently it includes something more than original Create React App package:

Building multiple bundles

If you want to make several bundles and have their own implementation of blocks, you need to use sets

  1. Add sets in .bemrc
  2. Build the project. You can specify some options for parallel-webpack (watch, maxRetries, stats)
  3. Run app with npm run start set-name

Contributing

We'd love to have your helping hand on create-bem-react-app! See CONTRIBUTING.md for more information on what we're looking for and how to get started.