Skip to content
This repository was archived by the owner on Jan 13, 2025. It is now read-only.

Commit f2368a6

Browse files
authored
📚 notices about CRA 2 incompatibility
1 parent 16e6ec7 commit f2368a6

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Ensure [requirements](#user-content-requires) are met, then execute the followin
6363
✏️ *Replace `$APP_NAME` with the name for your unique app.*
6464

6565
```bash
66-
npx create-react-app $APP_NAME
66+
npx create-react-app@1.5.x $APP_NAME
6767
cd $APP_NAME
6868
git init
6969
heroku create $APP_NAME --buildpack mars/create-react-app
@@ -86,12 +86,13 @@ Usage
8686
✏️ *Replace `$APP_NAME` with the name for your unique app.*
8787

8888
```bash
89-
npx create-react-app $APP_NAME
89+
npx create-react-app@1.5.x $APP_NAME
9090
cd $APP_NAME
9191
```
9292

9393
* [npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) comes with npm 5.2+ and higher, see [instructions for older npm versions](https://gist.github.com/gaearon/4064d3c23a77c74a3614c498a8bb1c5f)
94-
* If [yarn](https://yarnpkg.com) is installed locally, the new app will use it instead of [npm](https://www.npmjs.com).
94+
* if [yarn](https://yarnpkg.com) is installed locally, the new app will use it instead of [npm](https://www.npmjs.com)
95+
* version 1.5.x is specified because [runtime env vars](#user-content-runtime-configuration) are not yet compatible with version 2.0.x ([issue #131](https://github.com/mars/create-react-app-buildpack/issues/131))
9596

9697
### Make it a git repo
9798

@@ -384,6 +385,8 @@ REACT_APP_HEROKU_SLUG_COMMIT=$HEROKU_SLUG_COMMIT react-scripts build
384385

385386
Supports only [`REACT_APP_`](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md#adding-custom-environment-variables) prefixed variables.
386387

388+
🚨 *Not yet compatible with **Create React App 2** ([issue #131](https://github.com/mars/create-react-app-buildpack/issues/131))*
389+
387390
🚫🤐 ***Not for secrets.** These values may be accessed by anyone who can see the React app.*
388391

389392
Install the [runtime env npm package](https://www.npmjs.com/package/@mars/heroku-js-runtime-env):

0 commit comments

Comments
 (0)