Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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.
- Host: GitHub
- URL: https://github.com/adel-gu/room-management
- Owner: adel-gu
- License: other
- Created: 2024-06-27T08:40:12.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-12-21T15:55:53.000Z (27 days ago)
- Last Synced: 2024-12-21T16:39:55.734Z (27 days ago)
- Topics: express, mongodb, mongoose, nodejs, react, styled-components, tanstack-react-query, typescript
- Language: TypeScript
- Homepage: https://room-management-giky.onrender.com
- Size: 3.92 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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** is a comprehensive room management and reservation platform designed to streamline operations for administrators and guests alike.
- React
- TypeScript
- TanStack Query
- Styled-components
- Node.js
- Express
- MongoDB
- Mongoose
- JSON Web Token
- **Room management with role-based permissions**
- **Visitor and guest registration**
- **Secure authentication and authorization using JWT**
- **Image upload and optimization with Cloudinary**
- [Live Demo Link](https://room-management-giky.onrender.com/)
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
```
👤 **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/)
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you like this project, please give it a ⭐!
This project is [MIT](./LICENSE) licensed.