Skip to content

Commit 7a6e8d8

Browse files
#TRAPWLS-19 Readme content updating
1 parent b5b262a commit 7a6e8d8

File tree

1 file changed

+28
-29
lines changed

1 file changed

+28
-29
lines changed

README.md

Lines changed: 28 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,54 @@
1-
# Getting Started with Create React App
1+
# Javascript CRUD with SampleTasks
22

33
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
44

5-
## Available Scripts
5+
### Features
6+
- **User authentication with Google Sign-In**: Users can sign in using their Google accounts for secure access.
67

7-
In the project directory, you can run:
88

9-
### `npm start`
9+
### Prerequisites
10+
You need to install:
11+
- Node.js 16 LTS [Download Node.js](https://nodejs.org/)
12+
- Npm 8 >= or yarn
1013

14+
### Steps to Installation
15+
**Step 1:** Clone the repo
16+
```bash
17+
- https://github.com/MohamedRizwan399/CRUDJavaScriptSampleProject.git
18+
```
19+
20+
**Step 2:** Install the dependencies using npm
21+
```bash
22+
- npm install
23+
```
24+
25+
**Step 3:** Run the application
26+
```bash
27+
- npm start
28+
```
1129
Runs the app in the development mode.\
1230
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
1331

1432
The page will reload when you make changes.\
1533
You may also see any lint errors in the console.
1634

17-
### `npm test`
18-
35+
**Step 4:** Run the test suites
36+
```bash
37+
- npm test
38+
```
1939
Launches the test runner in the interactive watch mode.\
2040
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
2141

42+
## To run build in Production
43+
2244
### `npm run build`
2345

2446
Builds the app for production to the `build` folder.\
2547
It correctly bundles React in production mode and optimizes the build for the best performance.
2648

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-
### `npm run 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.
4149

4250
## Learn More
4351

44-
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
45-
4652
To learn React, check out the [React documentation](https://reactjs.org/).
4753

4854
### Code Splitting
@@ -57,14 +63,7 @@ This section has moved here: [https://facebook.github.io/create-react-app/docs/a
5763

5864
This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
5965

60-
### Advanced Configuration
61-
62-
This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
6366

6467
### Deployment
6568

6669
This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
67-
68-
### `npm run build` fails to minify
69-
70-
This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)

0 commit comments

Comments
 (0)