Skip to content

Commit 14120c3

Browse files
committed
Update README
1 parent a952fb8 commit 14120c3

File tree

2 files changed

+19
-58
lines changed

2 files changed

+19
-58
lines changed

README.md

+19-58
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,29 @@
1-
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
1+
# ShiftLeft demo (Simpsons trivia)
22

3-
## Available Scripts
3+
## How to use
44

5-
In the project directory, you can run:
5+
Clone this repo
66

7-
### `npm start`
7+
```bash
8+
git clone [email protected]:javascriptmid/react-shift-left.git
9+
```
810

9-
Runs the app in the development mode.<br>
10-
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
11+
Install the dependencies
1112

12-
The page will reload if you make edits.<br>
13-
You will also see any lint errors in the console.
13+
```bash
14+
yarn
15+
```
1416

15-
### `npm test`
17+
Run the local server
1618

17-
Launches the test runner in the interactive watch mode.<br>
18-
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
19+
```bash
20+
yarn start
21+
```
1922

20-
### `npm run build`
23+
Build the app
2124

22-
Builds the app for production to the `build` folder.<br>
23-
It correctly bundles React in production mode and optimizes the build for the best performance.
25+
```bash
26+
yarn build
27+
```
2428

25-
The build is minified and the filenames include the hashes.<br>
26-
Your app is ready to be deployed!
27-
28-
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
29-
30-
### `npm run eject`
31-
32-
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
33-
34-
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.
35-
36-
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.
37-
38-
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.
39-
40-
## Learn More
41-
42-
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
43-
44-
To learn React, check out the [React documentation](https://reactjs.org/).
45-
46-
### Code Splitting
47-
48-
This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
49-
50-
### Analyzing the Bundle Size
51-
52-
This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
53-
54-
### Making a Progressive Web App
55-
56-
This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
57-
58-
### Advanced Configuration
59-
60-
This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
61-
62-
### Deployment
63-
64-
This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
65-
66-
### `npm run build` fails to minify
67-
68-
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify
29+
![away-from-javascript](/screen.png)

screen.png

30.1 KB
Loading

0 commit comments

Comments
 (0)