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: README.md
+28-10Lines changed: 28 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,10 @@
1
1
# Create React Sandbox
2
2
3
-
[](https://github.com/bruce-x-wu/create-react-sandbox/actions/workflows/workflow_js.yml)
4
-
[](https://github.com/bruce-x-wu/create-react-sandbox/actions/workflows/workflow_ts.yml)
Create a lightweight React sandbox on your local system that runs like [Create React App](https://github.com/facebook/create-react-app) but without all the dependencies.
So far, Create React Sandbox has been tested on Windows and on an Ubuntu Github workflow. If something does not work please [file an issue](https://github.com/bruce-x-wu/create-react-sandbox/issues).
7
+
Create a lightweight React sandbox on your local system that runs like [Create React App](https://github.com/facebook/create-react-app) but without all the dependencies.
The sandbox app will run on [http://localhost:3001](http://localhost:3001) (or if you have a `PORT` environment variable set, it will run on that instead).
26
+
27
+
To build your code, run `npm run build`. The build output will be in the `dist` directory.
28
+
29
+
## Configuration
30
+
31
+
To set the name of your sandbox, use the `--name` option.
32
+
33
+
```bash
34
+
npx create-react-sandbox --name project-name
35
+
cd project-name
23
36
npm start
24
37
```
25
38
26
39
If you would like to use TypeScript in your project, run with the `-t` flag.
In either case, the sandbox app will run on [http://localhost:3001](http://localhost:3001) (or if you have a `PORT` environment variable set, it will run on that instead).
47
+
To add [Eslint](https://eslint.org) support, run with the `-l` flag.
35
48
36
-
To build your code, run `npm run build`. The build output will be in the `dist` directory.
49
+
```bash
50
+
npx create-react-sandbox -l # or `npx create-react-sandbox -t -l` for ts and eslint support
0 commit comments