Skip to content

Commit 5ab53bc

Browse files
committed
Update README.md
1 parent a201611 commit 5ab53bc

File tree

1 file changed

+24
-3
lines changed

1 file changed

+24
-3
lines changed

README.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,17 +87,38 @@ or [ProductHunt](https://www.producthunt.com/tech/react-static-boilerplate) &nbs
8787

8888
### Getting Started
8989

90-
Just clone the repo, install Node.js modules and run `npm start`:
90+
**1**. Make sure that you have [Node.js](https://nodejs.org/) v6 or newer installed on your machine.
91+
92+
**2**. Clone this repository or use [Yeoman
93+
generator](https://github.com/kriasoft/react-static-boilerplate/tree/generator-react-static) to
94+
bootstrap your project:
9195

9296
```shell
9397
$ git clone -o react-static-boilerplate -b master --single-branch \
9498
https://github.com/kriasoft/react-static-boilerplate.git MyApp
9599
$ cd MyApp
96100
$ npm install # Install project dependencies listed in package.json
97-
$ node run # Build and launch the app, same as `npm start`
98101
```
99102

100-
**NODE**: Make sure that you have [Node.js](https://nodejs.org/) v6 installed on your local machine.
103+
<p align="center">——— or ———</p>
104+
105+
```shell
106+
$ npm install -g yo
107+
$ npm install -g generator-react-static
108+
$ mkdir MyApp
109+
$ cd MyApp
110+
$ yo react-static
111+
```
112+
113+
**3**. Compile and launch your app by running:
114+
115+
```shell
116+
$ node run # Same as `npm start` or `node run start`
117+
```
118+
119+
You can also test your app in release (production) mode by running `node run start --release` or
120+
with HMR and React Hot Loader disabled by running `node run start --no-hmr`. The app should become
121+
available at [http://localhost:3000/](http://localhost:3000/).
101122

102123

103124
### How to Test

0 commit comments

Comments
 (0)