m1thr4nd1r / HotelBooking

An API to manage the Booking of a single room hotel.

Hotel Booking 📝

A .NET Core API to manage booking for a hotel!

Documentation · Report Bug · Request Feature

📔 Table of Contents

• About the Project
  • Tech Stack
  • Features
• Getting Started
  • Prerequisites
  • Running Tests
  • Run Locally
  • Deployment
• Usage
• Roadmap
• Contributing License
• Contact
• Acknowledgements

🌟 About the Project

👾 Tech Stack

Server

• .Net Core
• ASP.Net Core 6.0
• Swagger
• Fluent Assertions
• Fluent Validation
• Moq
• xUnit

Database

• EFCore InMemory Database

🎯 Features

• Check all bookings;
• Check a specific reservation;
• Place a booking;
• Modify a reservation;
• Cancel/Delete a booking;
• Check for a room's next availability.

🧰 Getting Started

‼️ Prerequisites

This project uses NuGet as the package manager

 nuget restore

🧪 Running Tests

To run tests, run the following command

  dotnet test

🏃 Run Locally

Clone the project

  git clone https://github.com/m1thr4nd1r/HotelBooking.git

Go to the project directory

  cd HotelBooking

Install dependencies and build the project

  dotnet build

Start the server

  dotnet run --project HotelBooking.API

👀 Usage

Upon locally running the project, the entry url (https://localhost:7218) will automatically redirect to the Swagger documentation index.

🧭 Roadmap

• Allow multi-client use with the same database.
• Allow primite types as parameters for Post and Put routes.

👋 Contributing

Contributions are always welcome!

⚠️ License

Distributed under the GNU General Public License v3.0 or later. See COPYING for more information.

🤝 Contact

Victor dos Santos - @Mithr4nd1r - [e-mail]

Project Link: https://github.com/m1thr4nd1r/HotelBooking

💎 Acknowledgements

Use this section to mention useful resources and libraries that you have used in your projects.

• Awesome README Template
• Shields.io
• Emoji Cheat Sheet