Merge pull request #97 from Ratnesh-Team/main

taking changes from main

README.md

@@ -1,48 +1,76 @@
-
+# Rehabify - Nasha Mukti Kendra Management Platform
+
+<table align="center">
+    <thead align="center">
+        <tr border: 2px;>
+            <td><b>🌟 Stars</b></td>
+            <td><b>🍴 Forks</b></td>
+            <td><b>🐛 Issues</b></td>
+            <td><b>🔔 Open PRs</b></td>
+            <td><b>🔕 Close PRs</b></td>
+        </tr>
+     </thead>
+    <tbody>
+         <tr>
+            <td><img alt="Stars" src="https://img.shields.io/github/stars/Ratnesh-Team/Rehabify?style=flat&logo=github"/></td>
+             <td><img alt="Forks" src="https://img.shields.io/github/forks/Ratnesh-Team/Rehabify?style=flat&logo=github"/></td>
+            <td><img alt="Issues" src="https://img.shields.io/github/issues/Ratnesh-Team/Rehabify?style=flat&logo=github"/></td>
+            <td><img alt="Open Pull Requests" src="https://img.shields.io/github/issues-pr/Ratnesh-Team/Rehabify?style=flat&logo=github"/></td>
+           <td><img alt="Close Pull Requests" src="https://img.shields.io/github/issues-pr-closed/Ratnesh-Team/Rehabify?style=flat&color=green&logo=github"/></td>
+        </tr>
+    </tbody>
+</table>
 
  ![Screenshot 2024-08-31 190300](https://github.com/user-attachments/assets/1b1b3514-183f-42f4-9d28-d33ebb74bb92)
 
- ## Super Admin Credentials
+ ## 🛡️ Super Admin Credentials
 
 - **Email**: [email protected]
 - **Password**: password@1
 
-## Admin Credentials
+## 🛡️ Admin Credentials
 
 - **Email**: [email protected]
 - **Password**: 123Qwe1
 
-## User Credentials
+## 🛡️ User Credentials
 
 - **Email**: [email protected]
 - **Password**: 123Qwe1
 
-# Rehabify - Rehabilitation and Nasha Mukti Kendra Management Platform
+<img src="https://www.animatedimages.org/data/media/562/animated-line-image-0184.gif" width="1920" />
+
+## 🌟 Overview
+
+**Rehabify** is an all-in-one management platform tailored for rehabilitation centers and Nasha Mukti Kendras. It streamlines operations by enabling administrators, doctors, and users to connect efficiently. The platform allows admins to register centers, doctors to associate with specific centers, and users to search for the nearest facilities. A super admin oversees the entire platform, ensuring smooth management and approval processes.
 
-## Overview
+## 🚀 Key Features
 
-Rehabify is a comprehensive management platform designed for rehabilitation and Nasha Mukti Kendra centers. The platform allows Nasha Mukti Kendra admins to register, doctors to register, and users to search for the nearest Nasha Mukti Kendra. Additionally, a super admin can approve registrations and manage the platform.
+- **🔐 Admin Registration**: Nasha Mukti Kendra administrators can register and manage their rehabilitation centers.
+- **👨‍⚕️ Doctor Registration**: Doctors can easily register and link with specific centers, making it simpler to offer specialized care.
+- **📍 User Search**: Users can locate the nearest Nasha Mukti Kendra, ensuring access to rehabilitation services when needed.
+- **🛡️ Super Admin Approval**: The super admin has control over approving registrations and managing the platform efficiently.
+- **🔑 Secure Authentication**: Robust login mechanisms for super admins, admins, doctors, and users, ensuring secure access to sensitive information.
+
 
-## Features
+## 🛠️ Project Structure
 
-- **Admin Registration**: Nasha Mukti Kendra admins can register and manage their centers.
-- **Doctor Registration**: Doctors can register and be associated with specific centers.
-- **User Search**: Users can search for the nearest Nasha Mukti Kendra.
-- **Super Admin Approval**: Super admin can approve registrations and manage the platform.
-- **Authentication**: Secure login for super admin, admin, and users.
+- **Backend**: Developed with **Go** and **MongoDB** for high performance and scalability.
+- **Frontend**: Crafted with **React** and **TypeScript** for a dynamic, user-friendly experience.
 
-## Project Structure
+<img src="https://www.animatedimages.org/data/media/562/animated-line-image-0184.gif" width="1920" />
 
-- **Backend**: Built with Go and MongoDB.
-- **Frontend**: Built with React and TypeScript.
+## 📝 Contributing
+
+For contributing to this repository, make sure you raise a pull request to the `develop` branch.
 
 ## Setup Instructions
 
 ### Backend Setup
 
 1. **Clone the repository**:
     ```bash
-    https://github.com/Ratnesh-Team/Rehabify.git
+    git clone https://github.com/Ratnesh-Team/Rehabify.git
     cd Rehabify/Backend
     ```
 
@@ -51,16 +79,14 @@ Rehabify is a comprehensive management platform designed for rehabilitation and
     go mod tidy
     ```
 
-3. **Set up MongoDB**:
-   Create a `.env` file in the `Backend` directory and add the following environment variables:
-    ```env
-    MONGOURI= your mongo url
-    ```
+3. **Create a .env File**:
+   Create a `.env` file in the `Backend` directory and add the environment variables mentioned in `sample.env` file 
 
 4. **Run the backend server**:
     ```bash
     go run main.go
     ```
+<img src="https://www.animatedimages.org/data/media/562/animated-line-image-0184.gif" width="1920" />
 
 ### Frontend Setup
 
@@ -74,29 +100,49 @@ Rehabify is a comprehensive management platform designed for rehabilitation and
     npm install
     ```
 
-3. **Run the frontend server**:
+3. **Create a .env File**:
+   Create a `.env` file in the `Frontkend` directory and add the environment variables mentioned in `sample.env` file 
+
+4. **Run the frontend server**:
     ```bash
     npm start
     ```
+<img src="https://www.animatedimages.org/data/media/562/animated-line-image-0184.gif" width="1920" />
 
 ## Usage
 
 1. **Access the platform**:
     - Open your browser and navigate to `http://localhost:5173` for the frontend.
     - The backend server runs on `http://localhost:3000`.
+    - Api documentation is available on `http://localhost:3000/swagger-ui/index.html`
 
 2. **Login as Super Admin**:
     - Use the provided super admin credentials to log in and manage the platform.
 
 3. **Search for Nasha Mukti Kendra**:
     - Use the search functionality to find the nearest centers.
 
-## Contributing
+<img src="https://www.animatedimages.org/data/media/562/animated-line-image-0184.gif" width="1920" />
+
+## ⭐ Star the Repo
+
+If you find this project useful, please consider giving it a star ⭐ on GitHub. It helps the project gain visibility and encourages contributions from the community.
+
+## 📜 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Awesome contributors :star_struck:
+<a href="https://github.com/Ratnesh-Team/Rehabify/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=Ratnesh-Team/Rehabify" />
+</a> 
+
+<img src="https://www.animatedimages.org/data/media/562/animated-line-image-0184.gif" width="1920" />
 
-We welcome contributions! Please fork the repository and submit pull requests.
+<div align="center">
 
-## License
+### 🎉 Happy contributing! Keep exploring! 🌟
 
-This project is licensed under the MIT License.
+</div>