Skip to content

Commit 833c30b

Browse files
committed
Updated readme.
1 parent 3accbdd commit 833c30b

File tree

2 files changed

+98
-51
lines changed

2 files changed

+98
-51
lines changed

README.md

Lines changed: 28 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -37,73 +37,50 @@ _Once you've templated this out, you can remove the above section from this READ
3737

3838
# <% .Name %>
3939

40-
## React App
40+
## Create React App
4141

4242
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
4343

44-
## Available Scripts
44+
See full documentation [here](docs/create-react-app.md)
4545

46-
In the project directory, you can run:
46+
### Commands
4747

48-
### `yarn start`
48+
#### Install Dependencies
4949

50-
Runs the app in the development mode.<br />
51-
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
52-
53-
The page will reload if you make edits.<br />
54-
You will also see any lint errors in the console.
55-
56-
### `yarn test`
57-
58-
Launches the test runner in the interactive watch mode.<br />
59-
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
60-
61-
### `yarn build`
62-
63-
Builds the app for production to the `build` folder.<br />
64-
It correctly bundles React in production mode and optimizes the build for the best performance.
65-
66-
The build is minified and the filenames include the hashes.<br />
67-
Your app is ready to be deployed!
68-
69-
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
70-
71-
### `yarn eject`
72-
73-
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
74-
75-
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
76-
77-
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
78-
79-
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
80-
81-
## Learn More
82-
83-
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
50+
```zsh
51+
yarn
52+
```
8453

85-
To learn React, check out the [React documentation](https://reactjs.org/).
54+
#### Run locally
8655

87-
### Code Splitting
56+
```zsh
57+
yarn start
58+
```
8859

89-
This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
60+
#### Run Tests
9061

91-
### Analyzing the Bundle Size
62+
```zsh
63+
yarn test
64+
```
9265

93-
This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
66+
## Backend App
9467

95-
### Making a Progressive Web App
68+
To run the backend app locally all you need to do is build the container and run it alongside your app.
9669

97-
This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
70+
### Backend Repo
9871

99-
### Advanced Configuration
72+
The corresponding backend for this app is [zero-deployable-backend](https://github.com/commitdev/zero-deployable-backend)
10073

101-
This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
74+
```zsh
75+
git clone [email protected]:commitdev/zero-deployable-backend.git
76+
```
10277

103-
### Deployment
78+
### Docker
10479

105-
This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
80+
Build the docker image locally and run it. We need to set a Pod name so that the frontend can display that data.
10681

107-
### `yarn build` fails to minify
82+
```zsh
83+
docker build . -t zero-deployable-backend
10884

109-
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify
85+
docker run -p 8080:8080 -e SERVER_PORT=8080 -e POD_NAME="Fake POD name." zero-deployable-backend
86+
```

docs/create-react-app.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Create React App
2+
3+
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
4+
5+
## Available Scripts
6+
7+
In the project directory, you can run:
8+
9+
### `yarn start`
10+
11+
Runs the app in the development mode.<br />
12+
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
13+
14+
The page will reload if you make edits.<br />
15+
You will also see any lint errors in the console.
16+
17+
### `yarn test`
18+
19+
Launches the test runner in the interactive watch mode.<br />
20+
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
21+
22+
### `yarn build`
23+
24+
Builds the app for production to the `build` folder.<br />
25+
It correctly bundles React in production mode and optimizes the build for the best performance.
26+
27+
The build is minified and the filenames include the hashes.<br />
28+
Your app is ready to be deployed!
29+
30+
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
31+
32+
### `yarn eject`
33+
34+
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
35+
36+
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
37+
38+
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
39+
40+
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
41+
42+
## Learn More
43+
44+
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
45+
46+
To learn React, check out the [React documentation](https://reactjs.org/).
47+
48+
### Code Splitting
49+
50+
This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
51+
52+
### Analyzing the Bundle Size
53+
54+
This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
55+
56+
### Making a Progressive Web App
57+
58+
This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
59+
60+
### Advanced Configuration
61+
62+
This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
63+
64+
### Deployment
65+
66+
This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
67+
68+
### `yarn build` fails to minify
69+
70+
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify

0 commit comments

Comments
 (0)