Skip to content

Commit f043056

Browse files
author
Mike Nikles
authored
Rewrite the README.md as an example for other templates. (#1)
* Rewrite the README.md as an example for other templates. * Rename heading to "How To Get Started" * Update the Gitpod config.
1 parent c36ffcf commit f043056

File tree

2 files changed

+13
-40
lines changed

2 files changed

+13
-40
lines changed

.gitpod.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,6 @@ github:
1717
# add a check to pull requests (defaults to true)
1818
addCheck: true
1919
# add a "Review in Gitpod" button as a comment to pull requests (defaults to false)
20-
addComment: true
20+
addComment: false
2121
# add a "Review in Gitpod" button to the pull request's description (defaults to false)
22-
addBadge: false
22+
addBadge: true

README.md

Lines changed: 11 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,19 @@
1-
# Getting Started with Create React App
1+
# A Create React App on Gitpod
22

3-
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
3+
This is a [Create React App](https://create-react-app.dev/) template configured for ephemeral development environments on [Gitpod](https://www.gitpod.io/).
44

5-
## Available Scripts
5+
## How To Get Started
66

7-
In the project directory, you can run:
7+
To get started with React on Gitpod, you can use the `create-react-app`:
88

9-
### `yarn start`
9+
```bash
10+
npx create-react-app my-app
11+
```
1012

11-
Runs the app in the development mode.\
12-
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
13+
Then, add a [`.gitpod.yml`](./.gitpod.yml) file which contains the configuration to improve the developer experience on Gitpod.
1314

14-
The page will reload if you make edits.\
15-
You will also see any lint errors in the console.
15+
## Next Steps
1616

17-
### `yarn test`
17+
Click the button below to start a new development environment on Gitpod:
1818

19-
Launches the test runner in the interactive watch mode.\
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.\
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.\
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/).
19+
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/gitpod-io/template-typescript-react)

0 commit comments

Comments
 (0)