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
This merge is much more complicated than it should have been. Apparently, the parent project spun off a 0.9.x branch around 0.9.2 or so and never merged it back into master. Thus, there are a signficant number of changes here that resulted from conflicts between their branches.
In this commit, I modified our `lint` script to match the changes made upstream in the other scripts.
This commit merges some of our customizations in, but not all yet. I'll add those back in later commits.
In particular:
* I haven't added Sass and CSS modules support back into the Webpack configuration files.
* I haven't added back the changes needed to resolve imports from the `client` directory.
* I haven't added back the changes needed to configure the public path in dev mode; the `start` script was refactored heavily, so we need to figure out how to do what we need to do.
* I haven't added back the changes needed to keep the browser from automatically opening.
This package is the heart of the project, which contains the scripts for setting up the development server, building production builds, configuring all software used, etc.<br>
72
+
All functionality must be retained (and configuration given to the user) if they choose to eject.
73
+
44
74
## Setting Up a Local Copy
45
75
46
76
1. Clone the repo with `git clone https://github.com/facebookincubator/create-react-app`
@@ -58,6 +88,8 @@ cd my-app
58
88
59
89
and then run `npm start` or `npm run build`.
60
90
91
+
*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.*
92
+
61
93
## Cutting a Release
62
94
63
95
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.
You **don’t** need to install or configure tools like Webpack or Babel.<br>
29
+
They are preconfigured and hidden so that you can focus on the code.
30
+
31
+
Just create a project, and you’re good to go.
32
+
26
33
## Getting Started
27
34
28
35
### Installation
@@ -33,11 +40,9 @@ Install it once globally:
33
40
npm install -g create-react-app
34
41
```
35
42
36
-
**You’ll need to have Node >= 4 on your machine**.
37
-
38
-
**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.
39
44
40
-
**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.
45
+
**This tool doesn’t assume a Node backend**. The Node installation is only required for Create React App itself.
41
46
42
47
### Creating an App
43
48
@@ -60,13 +65,15 @@ my-app/
60
65
public/
61
66
favicon.ico
62
67
index.html
68
+
manifest.json
63
69
src/
64
70
App.css
65
71
App.js
66
72
App.test.js
67
73
index.css
68
74
index.js
69
75
logo.svg
76
+
registerServiceWorker.js
70
77
```
71
78
72
79
No configuration or complicated folder structures, just the files you need to build your app.<br>
@@ -85,7 +92,7 @@ You will see the build errors and lint warnings in the console.
85
92
### `npm test` or `yarn test`
86
93
87
94
Runs the test watcher in an interactive mode.<br>
88
-
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.
89
96
90
97
[Read more about testing.](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#running-tests)
91
98
@@ -95,7 +102,9 @@ Builds the app for production to the `build` folder.<br>
95
102
It correctly bundles React in production mode and optimizes the build for the best performance.
96
103
97
104
The build is minified and the filenames include the hashes.<br>
98
-
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.
99
108
100
109
## User Guide
101
110
@@ -111,10 +120,11 @@ The [User Guide](https://github.com/facebookincubator/create-react-app/blob/mast
111
120
-[Changing the Page `<title>`](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#changing-the-page-title)
112
121
-[Installing a Dependency](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#installing-a-dependency)
113
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)
-[Adding Images, Fonts, and Files](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#adding-images-fonts-and-files)
118
128
-[Using the `public` Folder](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#using-the-public-folder)
119
129
-[Using Global Variables](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#using-global-variables)
@@ -127,7 +137,6 @@ The [User Guide](https://github.com/facebookincubator/create-react-app/blob/mast
127
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)
128
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)
131
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)
@@ -143,7 +152,7 @@ Please refer to the [User Guide](https://github.com/facebookincubator/create-rea
143
152
144
153
***One Dependency:** There is just one build dependency. It uses Webpack, Babel, ESLint, and other amazing projects, but provides a cohesive curated experience on top of them.
145
154
146
-
***Convention over Configuration:** You don't need to configure anything by default. Reasonably good configuration of both development and production builds is handled for you so you can focus on writing code.
155
+
***No Configuration Required:** You don't need to configure anything. Reasonably good configuration of both development and production builds is handled for you so you can focus on writing code.
147
156
148
157
***No Lock-In:** You can “eject” to a custom setup at any time. Run a single command, and all the configuration and build dependencies will be moved directly into your project, so you can pick up right where you left off.
149
158
@@ -157,6 +166,7 @@ Please refer to the [User Guide](https://github.com/facebookincubator/create-rea
157
166
* Import CSS and image files directly from JavaScript.
158
167
* Autoprefixed CSS, so you don’t need `-webkit` or other prefixes.
159
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.
160
170
161
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.
162
172
@@ -202,6 +212,11 @@ All of them are transitive dependencies of the provided npm package.
202
212
203
213
We'd love to have your helping hand on `create-react-app`! See [CONTRIBUTING.md](CONTRIBUTING.md) for more information on what we're looking for and how to get started.
204
214
215
+
## React Native
216
+
217
+
Looking for something similar, but for React Native?<br>
218
+
Check out [Create React Native App](https://github.com/react-community/create-react-native-app/).
219
+
205
220
## Acknowledgements
206
221
207
222
We are grateful to the authors of existing related projects for their ideas and collaboration:
@@ -231,7 +246,7 @@ Notable alternatives also include:
0 commit comments