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-3Lines changed: 1 addition & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -142,9 +142,7 @@ By default git would use `CRLF` line endings which would cause the scripts to fa
142
142
9. Wait for a long time, and it will get published. Don’t worry that it’s stuck. In the end the publish script will prompt for versions before publishing the packages.
143
143
10. After publishing, create a GitHub Release with the same text as the changelog entry. See previous Releases for inspiration.
144
144
145
-
Make sure to test the released version! If you want to be extra careful, you can publish a prerelease by running `npm run publish -- --npm-tag=next` instead of `npm run publish`.
146
-
147
-
Optionally, you can cut a prerelease instead by running `npm run publish -- --canary=next --exact --cd-version patch --npm-tag=next`.
145
+
Make sure to test the released version! If you want to be extra careful, you can publish a prerelease by running `npm run publish -- --canary=next --exact --cd-version patch --npm-tag=next` instead of `npm run publish`.
Copy file name to clipboardExpand all lines: README.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
@@ -163,7 +163,7 @@ Create React App is a great fit for:
163
163
-**Starting new single-page React applications.**
164
164
-**Creating examples** with React for your libraries and components.
165
165
166
-
Here are few common cases where you might want to try something else:
166
+
Here are a few common cases where you might want to try something else:
167
167
168
168
- If you want to **try React** without hundreds of transitive build tool dependencies, consider [using a single HTML file or an online sandbox instead](https://reactjs.org/docs/try-react.html).
**This is an optional feature.** Regular `<link>` stylesheets and CSS files are fully supported. CSS Modules are turned on for files ending with the `.module.css` extension.
Copy file name to clipboardExpand all lines: docusaurus/docs/adding-bootstrap.md
+5-13Lines changed: 5 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,18 +3,18 @@ id: adding-bootstrap
3
3
title: Adding Bootstrap
4
4
---
5
5
6
-
You don’t have to use [reactstrap](https://reactstrap.github.io/)together with React but it is a popular library for integrating Bootstrap with React apps. If you need it, you can integrate it with Create React App by following these steps:
6
+
While you don’t have to use any specific library to integrate Bootstrap with React apps, it's often easier than trying to wrap the Bootstrap jQuery plugins. [React Bootstrap](https://react-bootstrap.netlify.com/)is the most popular option, that strives for complete parity with bootstrap. [reactstrap](https://reactstrap.github.io/) is also a good choice for projects looking for smaller builds at the expense of some features.
7
7
8
-
Install reactstrap and Bootstrap from npm. reactstrap does not include Bootstrap CSS so this needs to be installed as well:
8
+
Each project's respective documentation site has detailed instructions for installing and using them. Both depend on the Bootstrap css file so install that as well:
9
9
10
10
```sh
11
-
npm install --save reactstrap bootstrap@4
11
+
npm install --save bootstrap
12
12
```
13
13
14
14
Alternatively you may use `yarn`:
15
15
16
16
```sh
17
-
yarn add bootstrap@4 reactstrap
17
+
yarn add bootstrap
18
18
```
19
19
20
20
Import Bootstrap CSS and optionally Bootstrap theme CSS in the beginning of your `src/index.js` file:
// components takes precedence over default styles.
26
26
```
27
27
28
-
Import required reactstrap components within `src/App.js` file or your custom component files:
29
-
30
-
```js
31
-
import { Button } from'reactstrap';
32
-
```
33
-
34
-
Now you are ready to use the imported reactstrap components within your component hierarchy defined in the render method. Here is an example [`App.js`](https://gist.githubusercontent.com/zx6658/d9f128cd57ca69e583ea2b5fea074238/raw/a56701c142d0c622eb6c20a457fbc01d708cb485/App.js) redone using reactstrap.
35
-
36
28
## Using a Custom Theme
37
29
38
30
> Note: this feature is available with `react-scripts@2.0.0` and higher.
39
31
40
32
Sometimes you might need to tweak the visual styles of Bootstrap (or equivalent package).<br>
41
33
As of `react-scripts@2.0.0` you can import `.scss` files. This makes it possible to use a package's built-in Sass variables for global style preferences.
42
34
43
-
To customize Bootstrap, create a file called `src/custom.scss` (or similar) and import the Bootstrap source stylesheet. Add any overrides _before_ the imported file(s). You can reference [Bootstrap's documentation](http://getbootstrap.com/docs/4.1/getting-started/theming/#css-variables) for the names of the available variables.
35
+
To customize Bootstrap, create a file called `src/custom.scss` (or similar) and import the Bootstrap source stylesheet. Add any overrides _before_ the imported file(s). You can reference [Bootstrap's documentation](https://getbootstrap.com/docs/4.1/getting-started/theming/#css-variables) for the names of the available variables.
> Note: this feature is available with `react-scripts@0.2.3` and higher.
8
8
9
-
Your project can consume variables declared in your environment as if they were declared locally in your JS files. By
10
-
default you will have `NODE_ENV` defined for you, and any other environment variables starting with
11
-
`REACT_APP_`.
9
+
Your project can consume variables declared in your environment as if they were declared locally in your JS files. By default you will have `NODE_ENV` defined for you, and any other environment variables starting with `REACT_APP_`.
10
+
11
+
> WARNING: Do not store any secrets (such as private API keys) in your React app!
12
+
>
13
+
> Environment variables are embedded into the build, meaning anyone can view them by inspecting your app's files.
12
14
13
15
**The environment variables are embedded during the build time**. Since Create React App produces a static HTML/CSS/JS bundle, it can’t possibly read them at runtime. To read them at runtime, you would need to load HTML into memory on the server and replace placeholders in runtime, just like [described here](title-and-meta-tags.md#injecting-data-from-the-server-into-the-page). Alternatively you can rebuild the app on the server anytime you change them.
14
16
15
17
> Note: You must create custom environment variables beginning with `REACT_APP_`. Any other variables except `NODE_ENV` will be ignored to avoid accidentally [exposing a private key on the machine that could have the same name](https://github.com/facebook/create-react-app/issues/865#issuecomment-252199527). Changing any environment variables will require you to restart the development server if it is running.
16
18
17
-
These environment variables will be defined for you on `process.env`. For example, having an environment
18
-
variable named `REACT_APP_SECRET_CODE` will be exposed in your JS as `process.env.REACT_APP_SECRET_CODE`.
19
+
These environment variables will be defined for you on `process.env`. For example, having an environment variable named `REACT_APP_NOT_SECRET_CODE` will be exposed in your JS as `process.env.REACT_APP_NOT_SECRET_CODE`.
19
20
20
21
There is also a special built-in environment variable called `NODE_ENV`. You can read it from `process.env.NODE_ENV`. When you run `npm start`, it is always equal to `'development'`, when you run `npm test` it is always equal to `'test'`, and when you run `npm run build` to make a production bundle, it is always equal to `'production'`. **You cannot override `NODE_ENV` manually.** This prevents developers from accidentally deploying a slow development build to production.
21
22
22
-
These environment variables can be useful for displaying information conditionally based on where the project is
23
-
deployed or consuming sensitive data that lives outside of version control.
23
+
These environment variables can be useful for displaying information conditionally based on where the project is deployed or consuming sensitive data that lives outside of version control.
24
24
25
-
First, you need to have environment variables defined. For example, let’s say you wanted to consume a secret defined
26
-
in the environment inside a `<form>`:
25
+
First, you need to have environment variables defined. For example, let’s say you wanted to consume an environment variable inside a `<form>`:
27
26
28
27
```jsx
29
28
render() {
30
29
return (
31
30
<div>
32
31
<small>You are running this application in<b>{process.env.NODE_ENV}</b> mode.</small>
During the build, `process.env.REACT_APP_SECRET_CODE` will be replaced with the current value of the `REACT_APP_SECRET_CODE` environment variable. Remember that the `NODE_ENV` variable will be set for you automatically.
40
+
During the build, `process.env.REACT_APP_NOT_SECRET_CODE` will be replaced with the current value of the `REACT_APP_NOT_SECRET_CODE` environment variable. Remember that the `NODE_ENV` variable will be set for you automatically.
42
41
43
42
When you load the app in the browser and inspect the `<input>`, you will see its value set to `abcdef`, and the bold text will show the environment provided when using `npm start`:
44
43
45
44
```html
46
45
<div>
47
46
<small>You are running this application in <b>development</b> mode.</small>
48
-
<form>
49
-
<inputtype="hidden"value="abcdef" />
50
-
</form>
47
+
<form><inputtype="hidden"value="abcdef" /></form>
51
48
</div>
52
49
```
53
50
54
-
The above form is looking for a variable called `REACT_APP_SECRET_CODE` from the environment. In order to consume this
55
-
value, we need to have it defined in the environment. This can be done using two ways: either in your shell or in
56
-
a `.env` file. Both of these ways are described in the next few sections.
51
+
The above form is looking for a variable called `REACT_APP_NOT_SECRET_CODE` from the environment. In order to consume this value, we need to have it defined in the environment. This can be done using two ways: either in your shell or in a `.env` file. Both of these ways are described in the next few sections.
57
52
58
53
Having access to the `NODE_ENV` is also useful for performing actions conditionally:
59
54
@@ -82,27 +77,26 @@ Note that the caveats from the above section apply:
82
77
83
78
## Adding Temporary Environment Variables In Your Shell
84
79
85
-
Defining environment variables can vary between OSes. It’s also important to know that this manner is temporary for the
86
-
life of the shell session.
80
+
Defining environment variables can vary between OSes. It’s also important to know that this manner is temporary for the life of the shell session.
87
81
88
82
### Windows (cmd.exe)
89
83
90
84
```cmd
91
-
set "REACT_APP_SECRET_CODE=abcdef" && npm start
85
+
set "REACT_APP_NOT_SECRET_CODE=abcdef" && npm start
92
86
```
93
87
94
88
(Note: Quotes around the variable assignment are required to avoid a trailing whitespace.)
To define permanent environment variables, create a file called `.env` in the root of your project:
113
107
114
108
```
115
-
REACT_APP_SECRET_CODE=abcdef
109
+
REACT_APP_NOT_SECRET_CODE=abcdef
116
110
```
117
111
118
112
> Note: You must create custom environment variables beginning with `REACT_APP_`. Any other variables except `NODE_ENV` will be ignored to avoid [accidentally exposing a private key on the machine that could have the same name](https://github.com/facebook/create-react-app/issues/865#issuecomment-252199527). Changing any environment variables will require you to restart the development server if it is running.
0 commit comments