aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLibravatarLibravatar Biswakalyan Bhuyan <biswa@surgot.in> 2024-07-18 11:46:05 +0000
committerLibravatarLibravatar Biswakalyan Bhuyan <biswa@surgot.in> 2024-07-18 11:46:05 +0000
commit90b1b7872547949b3b2c42bc7cc47457a1a2ec70 (patch)
treea3676e911b46a54ecb747a7bab8ec35a1fdf6f4d
parented01dc5e32172868dd210dd6eecac96680e47913 (diff)
downloadadmin-panel-90b1b7872547949b3b2c42bc7cc47457a1a2ec70.tar.gz
admin-panel-90b1b7872547949b3b2c42bc7cc47457a1a2ec70.tar.bz2
admin-panel-90b1b7872547949b3b2c42bc7cc47457a1a2ec70.zip
update README.md
-rw-r--r--README.md134
1 files changed, 67 insertions, 67 deletions
diff --git a/README.md b/README.md
index e11ce92..9ccf1a9 100644
--- a/README.md
+++ b/README.md
@@ -1,102 +1,102 @@
# Admin Panel Application
-This project is a full-stack application built with React.js for the frontend and Node.js/Express.js for the backend. It includes user authentication using Firebase, routing using React Router DOM, and data storage using MongoDB.
+ This project is a full-stack application built with React.js for the frontend and Node.js/Express.js for the backend. It includes user authentication using Firebase, routing using React Router DOM, and data storage using MongoDB.
-## Getting Started
+ ## Getting Started
-To get started with this project, follow these steps:
+ To get started with this project, follow these steps:
-### Prerequisites
+ ### Prerequisites
-- Node.js and npm should be installed on your machine.
-- MongoDB should be installed and running locally or accessible remotely.
+ - Node.js and npm should be installed on your machine.
+ - MongoDB should be installed and running locally or accessible remotely.
-### Installation
+ ### Installation
-1. Clone the repository to your local machine:
+ 1. Clone the repository to your local machine:
- ```bash
- git clone <repository_url>
- cd admin-panel
- ```
+ ```
+ git clone <repository_url>
+ cd admin-panel
+ ```
-2. Install dependencies for both the server and the client:
+ 2. Install dependencies for both the server and the client:
- ```bash
- # Install server dependencies
- cd server
- npm install
+ ```
+ # Install server dependencies
+ cd server
+ npm install
- # Install client dependencies
- cd ../src
- npm install
- ```
+ # Install client dependencies
+ cd ../src
+ npm install
+ ```
-### Configuration
+ ### Configuration
-#### Server Configuration
+ #### Server Configuration
-1. **Environment Variables**:
- - Create a `.env` file in the `server` directory and configure it with necessary environment variables (e.g., MongoDB URI, Firebase configuration).
+ 1. **Environment Variables**:
+ - Create a `.env` file in the `server` directory and configure it with necessary environment variables (e.g., MongoDB URI, Firebase configuration).
- Example `.env` file:
+ Example `.env` file:
- ```plaintext
- PORT=5000
- MONGODB_URI=mongodb://localhost:27017/admin-panel
- FIREBASE_API_KEY=your_firebase_api_key
- FIREBASE_AUTH_DOMAIN=your_firebase_auth_domain
- FIREBASE_PROJECT_ID=your_firebase_project_id
- ```
+ ```
+ PORT=5000
+ MONGODB_URI=mongodb://localhost:27017/admin-panel
+ FIREBASE_API_KEY=your_firebase_api_key
+ FIREBASE_AUTH_DOMAIN=your_firebase_auth_domain
+ FIREBASE_PROJECT_ID=your_firebase_project_id
+ ```
-2. **Database Setup**:
- - Ensure MongoDB is running. Modify the `MONGODB_URI` in `.env` to match your MongoDB setup.
+ 2. **Database Setup**:
+ - Ensure MongoDB is running. Modify the `MONGODB_URI` in `.env` to match your MongoDB setup.
-3. **Firebase Configuration**:
- - Update the Firebase configuration in `src/firebase/firebaseConfig.js` with your Firebase project credentials.
+ 3. **Firebase Configuration**:
+ - Update the Firebase configuration in `src/firebase/firebaseConfig.js` with your Firebase project credentials.
-#### Client Configuration
+ #### Client Configuration
-1. **React Router DOM**:
- - Ensure routes are correctly defined in `src/App.js` using `BrowserRouter`, `Route`, and `Switch` from `react-router-dom`.
+ 1. **React Router DOM**:
+ - Ensure routes are correctly defined in `src/App.js` using `BrowserRouter`, `Route`, and `Switch` from `react-router-dom`.
-2. **Firebase Integration**:
- - Ensure Firebase authentication and Firestore integration is set up correctly in `src/firebase/firebaseConfig.js`.
+ 2. **Firebase Integration**:
+ - Ensure Firebase authentication and Firestore integration is set up correctly in `src/firebase/firebaseConfig.js`.
-### Running the Application
+ ### Running the Application
-1. Start the server:
+ 1. Start the server:
- ```bash
- # From the server directory
- cd server
- npm start
- ```
+ ```
+ # From the server directory
+ cd server
+ npm start
+ ```
- The server should start on port specified in your `.env` file.
+ The server should start on port specified in your `.env` file.
-2. Start the React application:
+ 2. Start the React application:
- ```bash
- # From the src directory
- cd ../src
- npm start
- ```
+ ```
+ # From the src directory
+ cd ../src
+ npm start
+ ```
- The React application should start and open in your default web browser.
+ The React application should start and open in your default web browser.
-### Usage
+ ### Usage
-- The application includes user authentication using Firebase. Users can sign up, log in, and log out.
-- Private routes are implemented using `PrivateRoute.js` to protect routes that require authentication.
-- MongoDB is used for storing user data and other application-related data.
-- React components are organized under `src/components`, and Firebase configuration is under `src/firebase`.
+ - The application includes user authentication using Firebase. Users can sign up, log in, and log out.
+ - Private routes are implemented using `PrivateRoute.js` to protect routes that require authentication.
+ - MongoDB is used for storing user data and other application-related data.
+ - React components are organized under `src/components`, and Firebase configuration is under `src/firebase`.
-### Troubleshooting
+ ### Troubleshooting
-- If encountering `react-chartjs-2` or other dependency-related issues, ensure all dependencies are installed (`npm install`).
-- Check console logs for errors related to Firebase initialization, React Router DOM setup, or MongoDB connection issues.
+ - If encountering `react-chartjs-2` or other dependency-related issues, ensure all dependencies are installed (`npm install`).
+ - Check console logs for errors related to Firebase initialization, React Router DOM setup, or MongoDB connection issues.
-### License
+ ### License
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.