LODHA-BACKEND

◦ Developed with the software and tools below.

---

📖 Table of Contents

• 📖 Table of Contents
• 📍 Overview
• 📦 Features
• 📂 repository Structure
• ⚙️ Modules
• 🚀 Getting Started
  • 🔧 Installation
  • 🤖 Running lodha-backend
  • 🧪 Tests
• 🛣 Roadmap
• 🤝 Contributing
• 📄 License
• 👏 Acknowledgments

---

📂 Repository Structure

└── lodha-backend/
    ├── app.js
    ├── config/
    │   └── database.js
    ├── controllers/
    │   ├── NotifyController.js
    │   ├── complaintController.js
    │   ├── documentController.js
    │   ├── formController.js
    │   ├── issueController.js
    │   ├── logs/
    │   │   ├── complaint-issues.log.0
    │   │   ├── complaints.log.0
    │   │   ├── forms.log.0
    │   │   ├── meetings.log.0
    │   │   └── users.log.0
    │   ├── meetingController.js
    │   ├── resetPasswordController.js
    │   ├── userController.js
    │   └── userNotificationController.js
    ├── middleware/
    │   ├── auth.js
    │   ├── catchAsyncErrors.js
    │   └── error.js
    ├── models/
    │   ├── MeetingModel.js
    │   ├── Notifications.js
    │   ├── NotifyModel.js
    │   ├── complaintModel.js
    │   ├── documentModel.js
    │   ├── formModel.js
    │   ├── issueModel.js
    │   ├── userModel.js
    │   └── userNotification.js
    ├── package-lock.json
    ├── package.json
    ├── routes/
    │   ├── complaintsRoute.js
    │   ├── documentRoute.js
    │   ├── formRoute.js
    │   ├── issueRoute.js
    │   ├── meetingRoute.js
    │   ├── notificationRoute.js
    │   ├── resetPasswordRoute.js
    │   ├── userNotificationRoute.js
    │   └── userRoute.js
    ├── server.js
    └── utils/
        ├── apifeatures.js
        ├── errorhandler.js
        ├── imageUpload.js
        ├── jwtToken.js
        └── sendEmail.js

---

⚙️ Modules

Root

File	Summary
package-lock.json	HTTPStatus Exception: 429
server.js	HTTPStatus Exception: 429
package.json	HTTPStatus Exception: 429
app.js	HTTPStatus Exception: 429

Models

File	Summary
complaintModel.js	HTTPStatus Exception: 429
NotifyModel.js	HTTPStatus Exception: 429
issueModel.js	HTTPStatus Exception: 429
documentModel.js	HTTPStatus Exception: 429
formModel.js	HTTPStatus Exception: 429
Notifications.js	HTTPStatus Exception: 429
userModel.js	HTTPStatus Exception: 429
userNotification.js	HTTPStatus Exception: 429
MeetingModel.js	HTTPStatus Exception: 429

Config

File	Summary
database.js	HTTPStatus Exception: 429

Utils

File	Summary
sendEmail.js	HTTPStatus Exception: 429
errorhandler.js	HTTPStatus Exception: 429
imageUpload.js	HTTPStatus Exception: 429
apifeatures.js	HTTPStatus Exception: 429
jwtToken.js	HTTPStatus Exception: 429

Controllers

File	Summary
NotifyController.js	HTTPStatus Exception: 429
userController.js	HTTPStatus Exception: 429
userNotificationController.js	HTTPStatus Exception: 429
issueController.js	HTTPStatus Exception: 429
meetingController.js	HTTPStatus Exception: 429
documentController.js	HTTPStatus Exception: 429
resetPasswordController.js	HTTPStatus Exception: 429
complaintController.js	HTTPStatus Exception: 429
formController.js	HTTPStatus Exception: 429

Logs

File	Summary
complaint-issues.log.0	HTTPStatus Exception: 429
complaints.log.0	HTTPStatus Exception: 429
meetings.log.0	HTTPStatus Exception: 429
users.log.0	HTTPStatus Exception: 429
forms.log.0	HTTPStatus Exception: 429

Middleware

File	Summary
catchAsyncErrors.js	HTTPStatus Exception: 429
auth.js	HTTPStatus Exception: 429
error.js	HTTPStatus Exception: 429

Routes

File	Summary
notificationRoute.js	HTTPStatus Exception: 429
meetingRoute.js	HTTPStatus Exception: 429
formRoute.js	HTTPStatus Exception: 429
userNotificationRoute.js	HTTPStatus Exception: 429
resetPasswordRoute.js	HTTPStatus Exception: 429
issueRoute.js	HTTPStatus Exception: 429
complaintsRoute.js	HTTPStatus Exception: 429
documentRoute.js	HTTPStatus Exception: 429
userRoute.js	HTTPStatus Exception: 429

---

🚀 Getting Started

🔧 Installation

1. Clone the lodha-backend repository:

git clone https://github.com/Git-init-2022/lodha-backend

2. Change to the project directory:

cd lodha-backend

3. Install the dependencies:

npm install

🤖 Running lodha-backend

node app.js

🧪 Tests

npm test

---

🤝 Contributing

Contributions are welcome! Here are several ways you can contribute:

• Submit Pull Requests: Review open PRs, and submit your own PRs.
• Join the Discussions: Share your insights, provide feedback, or ask questions.
• Report Issues: Submit bugs found or log feature requests for GIT-INIT-2022.

Contributing Guidelines

Click to expand

1. Fork the Repository: Start by forking the project repository to your GitHub account.
2. Clone Locally: Clone the forked repository to your local machine using a Git client.

   git clone <your-forked-repo-url>

3. Create a New Branch: Always work on a new branch, giving it a descriptive name.

   git checkout -b new-feature-x

4. Make Your Changes: Develop and test your changes locally.
5. Commit Your Changes: Commit with a clear and concise message describing your updates.

   git commit -m 'Implemented new feature x.'

6. Push to GitHub: Push the changes to your forked repository.

   git push origin new-feature-x

7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.

Once your PR is reviewed and approved, it will be merged into the main branch.

---

📄 License

This project is protected under the SELECT-A-LICENSE License. For more details, refer to the LICENSE file.

---

👏 Acknowledgments

• List any resources, contributors, inspiration, etc. here.

Return

---