Skip to content

Commit 1f3e079

Browse files
committed
Update README.md with intro notes, docker scripts, yarn lint and ts commands
1 parent d3fbc3b commit 1f3e079

1 file changed

Lines changed: 30 additions & 15 deletions

File tree

README.md

Lines changed: 30 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,32 @@
11
# github-status
22

3-
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
3+
An alternative take on how github status page should look!
44

5-
## Available Scripts
5+
Based on the app-ideas repository: https://github.com/florinpop17/app-ideas/blob/master/Projects/1-Beginner/GitHub-Status-App.md
6+
7+
## Development
8+
9+
Start up the docker development container:
10+
11+
```
12+
./run-docker-development.sh
13+
```
14+
15+
Then you can run any of the scripts below.
16+
17+
### Available Scripts
618

719
In the project directory, you can run:
820

9-
### `yarn start`
21+
#### `yarn start`
1022

1123
Runs the app in the development mode.\
1224
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
1325

1426
The page will reload if you make edits.\
1527
You will also see any lint errors in the console.
1628

17-
### `yarn test`
18-
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`
29+
#### `yarn build`
2330

2431
Builds the app for production to the `build` folder.\
2532
It correctly bundles React in production mode and optimizes the build for the best performance.
@@ -29,18 +36,26 @@ Your app is ready to be deployed!
2936

3037
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
3138

32-
### `yarn eject`
33-
34-
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
39+
#### `yarn lint` / `yarn lint:fix`
3540

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.
41+
Runs eslint to check for strict typescript lint errors.\
42+
Run `yarn lint:fix` to attempt to fix any issues.
3743

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.
44+
#### `yarn ts` / `yarn ts-watch`
3945

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.
46+
Runs the typescript compiler (in watch mode with the latter command).\
47+
Running the development server also compiles typescript.
4148

4249
## Learn More
4350

4451
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
4552

4653
To learn React, check out the [React documentation](https://reactjs.org/).
54+
55+
## Super Linter
56+
57+
For all other linters, run the super lint docker container to check for errors:
58+
59+
```
60+
./run-super-linter.sh
61+
```

0 commit comments

Comments
 (0)