Skip to content

Commit f547ab4

Browse files
committed
Update README.md
1 parent d2e9b72 commit f547ab4

File tree

1 file changed

+18
-59
lines changed

1 file changed

+18
-59
lines changed

README.md

Lines changed: 18 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,27 @@
1-
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
1+
# React TODO
22

3-
## Available Scripts
3+
This is my first app using React. The code will be improved with experience :metal: :tada:
44

5-
In the project directory, you can run:
5+
[![react-todo-image](https://i.imgur.com/MN6lnMZ.png)](https://samuel27m.github.io/react-todo)
66

7-
### `npm start`
7+
## Installation
88

9-
Runs the app in the development mode.<br>
10-
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
9+
```
10+
git clone https://github.com/samuel27m/react-todo.git
11+
cd react-todo
12+
npm install
13+
npm start
14+
```
1115

12-
The page will reload if you make edits.<br>
13-
You will also see any lint errors in the console.
16+
## What does it use?
1417

15-
### `npm test`
18+
- React :roll_eyes:
19+
- Bootstrap v4
1620

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.
21+
## PWA
22+
Yes! This app uses the provided tools by React to be PWA compatible! [Open the website](https://samuel27m.github.io/react-todo) in your phone and you will see the button to add it to your home screen :smile: :tada:
1923

20-
### `npm run build`
24+
## How does this save my tasks?
25+
This app saves your tasks using the ```localStorage``` object, this means **your tasks will be saved offline**!
26+
Unfortunately also means that the data is not saved across all your devices :disappointed:
2127

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.
24-
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

0 commit comments

Comments
 (0)