Skip to content

A lightweight and multilingual management system for residential buildings. Administrators can manage announcements, debts, and residents, while users can view updates and their financial details.

License

Notifications You must be signed in to change notification settings

akcatech/simple-building-manager

Repository files navigation

Simple Building Management (SBM)

This is a simple and multilingual management system for residential communities. This application allows administrators to manage announcements, debts, and members, while residents can log in to view announcements and their financial details.


🚀 Features

  • Multilingual Support: Powered by next-intl, offering seamless multi-language capabilities.
  • Authentication: Secure authentication handled by Firebase.
  • Real-Time Database: Data is stored and managed using Firebase Firestore.
  • Material Design: Elegant UI powered by MUI.
  • Date Management: Intuitive date pickers provided by MUI X Date Pickers and Day.js.
  • Responsive Design: Styled with TailwindCSS for a mobile-first design approach.
  • Notifications: Real-time toast notifications using react-toastify.

🛠️ Technologies

This project is built using the following technologies and libraries:

Frontend

  • Next.js (14.x): React framework for server-side rendering and static site generation.
  • React (18.x): Core UI framework.
  • Material-UI (MUI): UI components and icons.
  • TailwindCSS: Utility-first CSS framework.
  • next-intl: Internationalization for Next.js.

Backend & Authentication

  • Firebase:
    • Authentication: @firebase/auth
    • Firestore Database: Real-time data storage and retrieval.

Utilities


🔧 Installation and Development

Follow these steps to set up the project locally:

Prerequisites

Steps

  1. Clone the repository:

    git clone https://github.com/your-username/site-management.git
    cd site-management
  2. Install dependencies:

    npm install

    or

    yarn install
  3. Configure Firebase:

    • Create a Firebase project in the Firebase Console.
    • Add the Firebase configuration to .env.local:
      NEXT_PUBLIC_FIREBASE_API_KEY=your-api-key
      NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=your-auth-domain
      NEXT_PUBLIC_FIREBASE_PROJECT_ID=your-project-id
      
  4. Start the development server:

    npm run dev

    or

    yarn dev
  5. Access the application: Open your browser and navigate to http://localhost:3000.

Build for Production

To build the application for production:

npm run build

Then start the production server:

npm start

📚 Contributing

Contributions are welcome! To get started:

  1. Fork the repository.
  2. Create a new branch:
    git checkout -b feature/your-feature-name
  3. Make your changes and commit them:
    git commit -m "Add your message here"
  4. Push to your branch:
    git push origin feature/your-feature-name
  5. Create a pull request.

📜 License

This project is licensed under the Apache 2.0 License. See the LICENSE file for details.


📸 Screenshots

Login User Management Announcement Management Dept Management (Add) Dept Management (List / Delete) Dept Status


🌟 Support

If you like this project, consider giving it a ⭐️ on GitHub!

About

A lightweight and multilingual management system for residential buildings. Administrators can manage announcements, debts, and residents, while users can view updates and their financial details.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published