You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -77,6 +77,8 @@ All functionality must be retained (and configuration given to the user) if they
77
77
78
78
2. Run `npm install` in the root `create-react-app` folder.
79
79
80
+
3.*(Only for macOS Sierra)*: Until [0.10.0](https://github.com/facebookincubator/create-react-app/milestone/23) is released, you may need to install [Watchman](https://facebook.github.io/watchman/docs/install.html) (e.g. `brew install watchman`).
81
+
80
82
Once it is done, you can modify any file locally and run `npm start`, `npm test` or `npm run build` just like in a generated project.
81
83
82
84
If you want to try out the end-to-end flow with the global CLI, you can do this too:
@@ -88,6 +90,8 @@ cd my-app
88
90
89
91
and then run `npm start` or `npm run build`.
90
92
93
+
*Note: if you are using yarn, we suggest that you use `yarn install --no-lockfile` instead of the bare `yarn` or `yarn install` because we [intentionally](https://github.com/facebookincubator/create-react-app/pull/2014#issuecomment-300811661) do not ignore or add yarn.lock to our repo.*
94
+
91
95
## Cutting a Release
92
96
93
97
1. Tag all merged pull requests that go into the release with the relevant milestone. Each merged PR should also be labeled with one of the [labels](https://github.com/facebookincubator/create-react-app/labels) named `tag: ...` to indicate what kind of change it is.
Copy file name to clipboardExpand all lines: README.md
+9-7Lines changed: 9 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,9 +40,7 @@ Install it once globally:
40
40
npm install -g create-react-app
41
41
```
42
42
43
-
**You’ll need to have Node >= 4 on your machine**.
44
-
45
-
**We strongly recommend to use Node >= 6 and npm >= 3 for faster installation speed and better disk usage.** You can use [nvm](https://github.com/creationix/nvm#usage) to easily switch Node versions between different projects.
43
+
**You’ll need to have Node >= 6 on your machine**. You can use [nvm](https://github.com/creationix/nvm#usage) to easily switch Node versions between different projects.
46
44
47
45
**This tool doesn’t assume a Node backend**. The Node installation is only required for Create React App itself.
48
46
@@ -67,13 +65,15 @@ my-app/
67
65
public/
68
66
favicon.ico
69
67
index.html
68
+
manifest.json
70
69
src/
71
70
App.css
72
71
App.js
73
72
App.test.js
74
73
index.css
75
74
index.js
76
75
logo.svg
76
+
registerServiceWorker.js
77
77
```
78
78
79
79
No configuration or complicated folder structures, just the files you need to build your app.<br>
@@ -92,7 +92,7 @@ You will see the build errors and lint warnings in the console.
92
92
### `npm test` or `yarn test`
93
93
94
94
Runs the test watcher in an interactive mode.<br>
95
-
By default, runs tests related to files changes since the last commit.
95
+
By default, runs tests related to files changed since the last commit.
96
96
97
97
[Read more about testing.](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#running-tests)
98
98
@@ -102,7 +102,9 @@ Builds the app for production to the `build` folder.<br>
102
102
It correctly bundles React in production mode and optimizes the build for the best performance.
103
103
104
104
The build is minified and the filenames include the hashes.<br>
105
-
Your app is ready to be deployed!
105
+
By default, it also [includes a service worker](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#making-a-progressive-web-app) so that your app loads from local cache on future visits.
106
+
107
+
Your app is ready to be deployed.
106
108
107
109
## User Guide
108
110
@@ -118,6 +120,7 @@ The [User Guide](https://github.com/facebookincubator/create-react-app/blob/mast
118
120
-[Changing the Page `<title>`](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#changing-the-page-title)
119
121
-[Installing a Dependency](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#installing-a-dependency)
120
122
-[Importing a Component](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#importing-a-component)
-[Adding a Stylesheet](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#adding-a-stylesheet)
-[Adding a CSS Preprocessor (Sass, Less etc.)](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#adding-a-css-preprocessor-sass-less-etc)
@@ -134,7 +137,6 @@ The [User Guide](https://github.com/facebookincubator/create-react-app/blob/mast
134
137
-[Generating Dynamic `<meta>` Tags on the Server](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#generating-dynamic-meta-tags-on-the-server)
135
138
-[Pre-Rendering into Static HTML Files](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#pre-rendering-into-static-html-files)
-[Developing Components in Isolation](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#developing-components-in-isolation)
138
140
-[Making a Progressive Web App](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#making-a-progressive-web-app)
@@ -164,6 +166,7 @@ Please refer to the [User Guide](https://github.com/facebookincubator/create-rea
164
166
* Import CSS and image files directly from JavaScript.
165
167
* Autoprefixed CSS, so you don’t need `-webkit` or other prefixes.
166
168
* A `build` script to bundle JS, CSS, and images for production, with sourcemaps.
169
+
* An offline-first [service worker](https://developers.google.com/web/fundamentals/getting-started/primers/service-workers) and a [web app manifest](https://developers.google.com/web/fundamentals/engage-and-retain/web-app-manifest/), meeting all the [Progressive Web App](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#making-a-progressive-web-app) criteria.
167
170
168
171
**The feature set is intentionally limited**. It doesn’t support advanced features such as server rendering or CSS modules. The tool is also **non-configurable** because it is hard to provide a cohesive experience and easy updates across a set of tools when the user can tweak anything.
169
172
@@ -243,7 +246,6 @@ Notable alternatives also include:
0 commit comments