Skip to content

Commit 64a0de7

Browse files
Update README.md
Small corrections to ease readability.
1 parent 38f5c9f commit 64a0de7

File tree

1 file changed

+15
-17
lines changed

1 file changed

+15
-17
lines changed

00 Boilerplate/readme.md

+15-17
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
# 00 Boilerplate
22

3-
In this sample we are going to setup the basic plumbing to "build" our project and launch it in a dev server.
3+
In this sample we setup the basic plumbing to "build" our project and launch it in a dev server.
44

5-
We won't install anything related about React, just some basic plumbing. In sample 01 we will start by importing
6-
React and ReactDOM.
5+
We won't install anything related to React, but some basic plumbing. React and ReactDOM are imported in sample 01.
76

8-
We will setup an initial <abbr title="Node.js package manager, a package manager for the JavaScript runtime environment Node.js">npm</abbr> project, give support to TypeScript, and install React.<br />
9-
Then we will create a **helloworld.ts** sample.
7+
We setup an initial <abbr title="Node.js package manager, a package manager for the JavaScript runtime environment Node.js">npm</abbr> project, give support to TypeScript, and install React.<br />
8+
Then we create a **helloworld.ts** sample.
109

1110
Summary steps:
1211

@@ -18,7 +17,7 @@ Summary steps:
1817
- Babel.
1918
- Bootstrap.
2019
- Setup **[./webpack.config.js](./webpack.config.js)**
21-
- Create a test js file.
20+
- Create a test JS file.
2221
- Create a simple HTML file.
2322

2423
# Prerequisites
@@ -31,8 +30,8 @@ Install [Node.js and npm](https://nodejs.org/en/) (v8.9.1) if they are not alrea
3130

3231
- Create and navigate to the folder where you are going to create the empty project.
3332

34-
- Execute `npm init`, you will be prompted to answer some information request about the project (e.g. set name to _samplereact_ and description to _Sample working with React,TypeScript and Webpack_).
35-
Once you have successfully fullfilled them a **[./package.json](./package.json)** file we will generated.
33+
- Execute `npm init`. You are prompted to answer some questions about the project (e.g. set name to _samplereact_ and description to _Sample working with React,TypeScript and Webpack_).
34+
Once you have successfully answered them, a **[./package.json](./package.json)** file is generated.
3635

3736
```bash
3837
npm init
@@ -49,13 +48,13 @@ Once you have successfully fullfilled them a **[./package.json](./package.json)*
4948
npm install webpack-dev-server --save-dev
5049
```
5150

52-
- Let's install a list of plugins and loaders that will add powers to our webpack configuration (handling <abbr title="Cascading Style Sheets">CSS</abbr>, TypeScript...).
51+
- Let's install a list of plugins and loaders to add capabilities to our webpack configuration (handling <abbr title="Cascading Style Sheets">CSS</abbr>, TypeScript...).
5352

5453
```bash
5554
npm install css-loader style-loader file-loader url-loader html-webpack-plugin awesome-typescript-loader mini-css-extract-plugin --save-dev
5655
```
5756

58-
- Let's add two commands to our **[./package.json](./package.json)** to build and start.
57+
- Let's add two commands to our **[./package.json](./package.json)**: build and start.
5958

6059
_[./package.json](./package.json)_
6160
```diff
@@ -65,7 +64,7 @@ _[./package.json](./package.json)_
6564
},
6665
```
6766

68-
- Let's install locally TypeScript:
67+
- Let's install TypeScript locally:
6968

7069
```bash
7170
npm install typescript --save-dev
@@ -100,7 +99,7 @@ _[./tsconfig.json](./tsconfig.json)_
10099
npm install babel-core babel-preset-env --save-dev
101100
```
102101

103-
- Babel needs to be configured for works. We will create one file **[./.babelrc](./.babelrc)** in root and later we will see how to put it in **[./webpack.config.js](./webpack.config.js)**. In this example, we will use this .babelrc:
102+
- Babel needs to be configured for it to work. We create **[./.babelrc](./.babelrc)** in the root folder. Later we will see how to put it in **[./webpack.config.js](./webpack.config.js)**. In this example, we use this .babelrc:
104103

105104
_[./.babelrc](./.babelrc)_
106105
```json
@@ -122,7 +121,7 @@ _[./.babelrc](./.babelrc)_
122121
npm install bootstrap --save
123122
```
124123

125-
- Now, our **[./package.json](./package.json)** file should looks something like:
124+
- Now, our **[./package.json](./package.json)** file should look something like:
126125

127126
_[./package.json](./package.json)_
128127
```json
@@ -190,11 +189,10 @@ _[./src/index.html](./src/index.html)_
190189
</html>
191190
```
192191

193-
- Now it's time to create a basic **[./webpack.config.js](./webpack.config.js)** file, this configuration will
194-
include plumbing for:
192+
- Now it's time to create a basic **[./webpack.config.js](./webpack.config.js)** file. This configuration includes plumbing for:
195193
- Launching a web dev server.
196194
- Transpiling from TypeScript to JavaScript.
197-
- Setup Twitter Bootstrap (including fonts, etc...).
195+
- Setting up Twitter Bootstrap (including fonts, etc...).
198196
- Generating the build under a **dist** folder.
199197

200198
_[./webpack.config.js](./webpack.config.js)_
@@ -265,7 +263,7 @@ module.exports = {
265263
};
266264
```
267265

268-
- Run webpack with:
266+
- Run webpack:
269267

270268
```bash
271269
npm start

0 commit comments

Comments
 (0)