Room Manager

🔗 Table of Contents

• 🔓 About the Project
  • 🔧 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 💪 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📃 License

🔓 Room Manager

Room Manager is a comprehensive room management and reservation platform designed to streamline operations for administrators and guests alike.

🔧 Built With

• React
• TypeScript
• TanStack Query
• Styled-components
• Node.js
• Express
• MongoDB
• Mongoose
• JSON Web Token

Key Features

• Room management with role-based permissions
• Visitor and guest registration
• Secure authentication and authorization using JWT
• Image upload and optimization with Cloudinary

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

• Node.js installed on your machine.

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:adel-gu/room-management.git

Install

Install this project with:

  cd room-management

  cd client
  pnpm install

  cd server
  pnpm install

Usage

To run the project, execute the following command:

  cd client
  pnpm run dev

  cd server
  pnpm run dev

(back to top)

👥 Authors

👤 Adel Guitoun

• GitHub: @adel-gu
• Twitter: @GuitounAdel
• LinkedIn: adelguitoun

👤 Terbeche Mostefa

• GitHub: @Terbeche
• LinkedIn: mustapha-terbeche

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, please give it a ⭐!

(back to top)

📃 License

This project is MIT licensed.

(back to top)