Skip to content

Commit 2356827

Browse files
#TRAPWLS-19 updated for production
1 parent 4499b1c commit 2356827

1 file changed

Lines changed: 79 additions & 0 deletions

File tree

README.md

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# Javascript CRUD with SampleTasks
2+
3+
A Javascript application to demonstrate the comprehensive **CRUD** app built using ReactJS and Firebase. It implement user authentication with both Google Sign-In and username/password login methods, along with other key features such as API handling, local storage CRUD operations, and managing application state using Redux.
4+
The app also leverages modern React hooks, lifecycle methods, and routing for smooth navigation between pages.
5+
6+
## Features
7+
- **User authentication with Google Sign-In**: Users can sign in using their Google accounts using Firebase for secure authentication.
8+
- **Username/Password Authentication**: Custom username and password login using Firebse for added flexibility.
9+
- **CRUD Operations**: Ability to perform create, read, update, and delete operations with data stored in local storage.
10+
- **API Handling with Axios**: Handled API requests using Axios for fetching data from remote servers.
11+
- **Data Management with Redux**: Efficiently manage app state using Redux store to handle data across components.
12+
- **React Hooks and Lifecycle Methods**: Utilization of React hooks like useState, useEffect, useRef and lifecycle methods for optimal component behavior.
13+
- **Dynamic Routing**: Implemented navigation between pages with React Router for a dynamic user experience.
14+
- **Loader Implementation**: Display a loader during asynchronous operations to improve user experience.
15+
- **Responsive UI**: Fully responsive UI with styling using CSS and modern design principles.
16+
- **Header and Footer**: The header includes navigation tabs, and the footer provides links to "About Us" and "Contact Us" pages.
17+
18+
19+
## Prerequisites
20+
You need to install required version:
21+
- Node.js 16 LTS [Download Node.js](https://nodejs.org/)
22+
- Npm 8 >= or yarn
23+
24+
## Steps to Installation
25+
**Step 1:** Clone the repo
26+
```bash
27+
- https://github.com/MohamedRizwan399/CRUDJavaScriptSampleProject.git
28+
```
29+
30+
**Step 2:** Install the dependencies using npm
31+
```bash
32+
- npm install
33+
```
34+
35+
**Step 3:** Run the application
36+
```bash
37+
- npm start
38+
```
39+
Runs the app in the development mode.\
40+
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
41+
42+
The page will reload when you make changes.\
43+
You may also see any lint errors in the console.
44+
45+
**Step 4:** Run the test suites
46+
```bash
47+
- npm test
48+
```
49+
Launches the test runner in the interactive watch mode.\
50+
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
51+
52+
**Step 5:** To run build in Production, if needed
53+
```bash
54+
- npm run build
55+
```
56+
Builds the app for production to the `build` folder.\
57+
It correctly bundles React in production mode and optimizes the build for the best performance.
58+
59+
60+
## Learn More
61+
62+
To learn React, check out the [React documentation](https://reactjs.org/).
63+
64+
### Code Splitting
65+
66+
This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
67+
68+
### Analyzing the Bundle Size
69+
70+
This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
71+
72+
### Making a Progressive Web App
73+
74+
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)
75+
76+
77+
### Deployment
78+
79+
This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)

0 commit comments

Comments
 (0)