Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/adel-gu/room-management

Hotel management system application.
https://github.com/adel-gu/room-management

express mongodb mongoose nodejs react styled-components tanstack-react-query typescript

Last synced: 4 days ago
JSON representation

Hotel management system application.

Awesome Lists containing this project

README

        

logo

Room Manager

# 🔗 Table of Contents

- [🔓 About the Project](#about-project)
- [🔧 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [💪 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📃 License](#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](https://room-management-giky.onrender.com/)

(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:

```sh
cd my-folder
git clone [email protected]:adel-gu/room-management.git
```

### Install

Install this project with:

```sh
cd room-management

cd client
pnpm install

cd server
pnpm install
```

### Usage

To run the project, execute the following command:

```sh
cd client
pnpm run dev

cd server
pnpm run dev
```

(back to top)

## 👥 Authors

👤 **Adel Guitoun**

- GitHub: [@adel-gu](https://github.com/adel-gu)
- Twitter: [@GuitounAdel](https://x.com/GuitounAdel)
- LinkedIn: [adelguitoun](https://www.linkedin.com/in/adelguitoun/)

👤 **Terbeche Mostefa**

- GitHub: [@Terbeche](https://github.com/Terbeche)
- LinkedIn: [mustapha-terbeche](https://www.linkedin.com/in/mustapha-terbeche/)

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

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

(back to top)

## 📃 License

This project is [MIT](./LICENSE) licensed.

(back to top)