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
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ Following these guidelines helps to communicate that you respect the time of the
10
10
11
11
As much as possible, we try to avoid adding configuration and flags. The purpose of this tool is to provide the best experience for people getting started with React, and this will always be our first priority. This means that sometimes we [sacrifice additional functionality](https://gettingreal.37signals.com/ch05_Half_Not_Half_Assed.php) (such as server rendering) because it is too hard to solve it in a way that wouldn’t require any configuration.
12
12
13
-
We prefer **convention, heuristics, or interactivity** over configuration.
13
+
We prefer **convention, heuristics, or interactivity** over configuration.<br>
Copy file name to clipboardExpand all lines: README.md
+12-6Lines changed: 12 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,6 +5,9 @@ Create React apps with no build configuration.
5
5
*[Getting Started](#getting-started) – How to create a new app.
6
6
*[User Guide](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md) – How to develop apps bootstrapped with Create React App.
7
7
8
+
Create React App works on macOS, Windows, and Linux.<br>
9
+
If something doesn’t work please [file an issue](https://github.com/facebookincubator/create-react-app/issues/new).
10
+
8
11
## tl;dr
9
12
10
13
```sh
@@ -13,7 +16,6 @@ npm install -g create-react-app
13
16
create-react-app my-app
14
17
cd my-app/
15
18
npm start
16
-
17
19
```
18
20
19
21
Then open [http://localhost:3000/](http://localhost:3000/) to see your app.<br>
@@ -70,7 +72,7 @@ my-app/
70
72
No configuration or complicated folder structures, just the files you need to build your app.<br>
71
73
Once the installation is done, you can run some commands inside the project folder:
72
74
73
-
### `npm start`
75
+
### `npm start` or `yarn start`
74
76
75
77
Runs the app in development mode.<br>
76
78
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
@@ -80,14 +82,14 @@ You will see the build errors and lint warnings in the console.
By default, runs tests related to files changes since the last commit.
87
89
88
90
[Read more about testing.](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#running-tests)
89
91
90
-
### `npm run build`
92
+
### `npm run build` or `yarn build`
91
93
92
94
Builds the app for production to the `build` folder.<br>
93
95
It correctly bundles React in production mode and optimizes the build for the best performance.
@@ -102,13 +104,16 @@ The [User Guide](https://github.com/facebookincubator/create-react-app/blob/mast
102
104
-[Updating to New Releases](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#updating-to-new-releases)
-[Supported Language Features and Polyfills](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#supported-language-features-and-polyfills)
105
108
-[Syntax Highlighting in the Editor](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#syntax-highlighting-in-the-editor)
106
109
-[Displaying Lint Output in the Editor](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#displaying-lint-output-in-the-editor)
110
+
-[Debugging in the Editor](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#debugging-in-the-editor)
107
111
-[Changing the Page `<title>`](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#changing-the-page-title)
108
112
-[Installing a Dependency](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#installing-a-dependency)
109
113
-[Importing a Component](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#importing-a-component)
110
114
-[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)
112
117
-[Adding Images and Fonts](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#adding-images-and-fonts)
113
118
-[Using the `public` Folder](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#using-the-public-folder)
114
119
-[Using Global Variables](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#using-global-variables)
@@ -120,6 +125,7 @@ The [User Guide](https://github.com/facebookincubator/create-react-app/blob/mast
120
125
-[Proxying API Requests in Development](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#proxying-api-requests-in-development)
121
126
-[Using HTTPS in Development](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#using-https-in-development)
122
127
-[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
+
-[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)
125
131
-[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)
@@ -173,7 +179,7 @@ Some features are currently **not supported**:
173
179
* Server rendering.
174
180
* Some experimental syntax extensions (e.g. decorators).
175
181
* CSS Modules.
176
-
* LESS or Sass.
182
+
*Importing LESS or Sass directly ([but you still can use them](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#adding-a-css-preprocessor-sass-less-etc)).
177
183
* Hot reloading of components.
178
184
179
185
Some of them might get added in the future if they are stable, are useful to majority of React apps, don’t conflict with existing tools, and don’t introduce additional configuration.
@@ -210,7 +216,7 @@ If you don’t agree with the choices made in this project, you might want to ex
210
216
Some of the more popular and actively maintained ones are:
0 commit comments