ajithnow / hotel-manager-laravel

The Hotel Manager App is an open-source web application designed to assist hoteliers in their day-to-day tasks. It provides a comprehensive solution for managing reservations, guest information, room allocation, billing, and more.

LaraEasy Hotel Management App

The LaraEasy Hotel Management App is an open-source web application designed to assist hoteliers in their day-to-day tasks. It provides a comprehensive solution for managing reservations, guest information, room allocation, billing, and more.

Features

• Reservation management: Create, update, and cancel reservations with ease.
• Guest check-in/check-out: Streamline the guest registration and departure process.
• Room allocation: Assign rooms to guests based on their preferences and availability.
• Billing: Generate invoices and manage billing information.
• Other Travel Agents (OTA) syncing.
• Reporting: Generate reports on occupancy, revenue, and other key metrics.
• User authentication and authorization: Secure access to the app's features based on user roles.

Technology Stack

• Backend:

  • PHP: Programming language for the backend.
  • Laravel: Lightweight HTTP framework for routing and request handling.
  • Rest: API layer for efficient data querying and manipulation.
  • MySql: Relational SQL database for data storage.

• Frontend:

  • React: TypeScript-based web application framework for building the user interface.

Prerequisites

• Docker: Installation Guide
• Docker Compose: Installation Guide

Build and Run the Docker Containers

To build and run the Docker containers for the Hotel Manager App, follow the steps below:

1. Clone the repository:

git clone https://github.com/ajithnow/hotel-manager-laravel.git

2. Go to directory

cd hotel-manager-laravel

3. Build the Docker images with sail:

docker run --rm \
    -u "$(id -u):$(id -g)" \
    -v "$(pwd):/var/www/html" \
    -w /var/www/html \
    laravelsail/php82-composer:latest \
    composer install --ignore-platform-reqs

This command will build the Docker images for Laravel Sail based on the configuration specified in the docker-compose.yml file.

4. Configuring A Shell Alias

alias sail='[ -f sail ] && sh sail || sh vendor/bin/sail'

5. Run the Docker containers:

sail up

This command will start the Docker containers for Laravel Sail. You should see the logs from each container displayed in the terminal.

6. Running Migrations

sail artisan migrate

7. Generating API Documentation

sail artisan l5-swagger:generate

8. Access the Hotel Manager App [DEV]:

Once the containers are up and running, you can access the Hotel Manager App in your web browser at http://localhost.

9. Acess the API Documentation

Once the containers are up and running, you can access the Hotel Manager App APIs in your web browser at http://localhost/api/documentation.

10. Stop the running containers:

To stop the Docker containers, press Ctrl + C in the terminal where the containers are running.

Contributing

Contributions to the Hotelier App are welcome! If you'd like to contribute, please follow these guidelines:

1. Fork the repository and create your branch:

git checkout -b feature/your-feature-name

2. Make your changes and commit them:

git commit -m "Add your commit message"

3. Push your branch to your forked repository:

git push origin feature/your-feature-name

4. Open a pull request in the main repository, describing your changes and the rationale behind them.

Please ensure that your contributions adhere to our Code of Conduct and Contributing Guidelines. By participating in this project, you agree to abide by these terms.

Thank you for contributing to the Hotelier App!

License

The LaraEasy Hotel Management App is open-source and released under the MIT License. Feel free to use, modify, and distribute the codebase as per the terms of the license.

Feel free to modify and customize this README file according to your specific project requirements. ....