Skip to content
This repository was archived by the owner on Jul 7, 2021. It is now read-only.

Commit 2a74b20

Browse files
committed
update readme file
1 parent 2a6a628 commit 2a74b20

File tree

1 file changed

+21
-55
lines changed

1 file changed

+21
-55
lines changed

README.md

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

3-
## Available Scripts
3+
[![Repository version](https://img.shields.io/badge/version-1.0.0--pre-brightgreen?style=plastic)](https://github.com/vishalnagda1/redux-demo/releases/tag/v1.0.0-pre)
44

5-
In the project directory, you can run:
5+
This is a pre-release version of Redux Demo React application which performs the basic functionality of fetching posts and creating new post. This application is using open source APIs provided by [JSONPlaceholder](https://jsonplaceholder.typicode.com/) to create and retrieve the posts.
66

7-
### `npm start`
7+
### Project Installation Guide
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+
##### Requirements
1110

12-
The page will reload if you make edits.<br />
13-
You will also see any lint errors in the console.
11+
**Node JS -** *12.15* or later versions.
1412

15-
### `npm test`
13+
**NPM -** *3.5* or later versions.
1614

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.
15+
**Editor -** Your favorite editor.
1916

20-
### `npm run build`
17+
**Browser -** Chrome >= *81.0* or Firefox >= *72.0.2*
2118

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.
19+
###### Steps
2420

25-
The build is minified and the filenames include the hashes.<br />
26-
Your app is ready to be deployed!
21+
1. Clone or download project in your system.
22+
2. Navigate to project directory in the terminal or command prompt.
23+
3. run `npm i`
24+
4. run `npm start`
25+
5. Your project server is running at [localhost:3000](http://localhost:3000)
2726

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

30-
### `npm run eject`
28+
#### Contributing
3129

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
30+
1. Fork it ( [https://github.com/vishalnagda1/redux-demo/fork](https://github.com/vishalnagda1/redux-demo/fork) )
31+
2. Create your feature branch (`git checkout -b my-new-feature`)
32+
3. Commit your changes (`git commit -am 'Add some feature'`)
33+
4. Push to the branch (`git push origin my-new-feature`)
34+
5. Create a new pull request.

0 commit comments

Comments
 (0)