Skip to content

RenzAljon24/hotel-service

Repository files navigation

For your Laravel backend repository, you can create a README that outlines the purpose of the backend, setup instructions, API endpoints, and credits. Here’s a template:


Hotel Haven - Laravel Backend

This repository contains the backend server for the Hotel Haven mobile hotel reservation app. Built with Laravel, it manages user authentication, room availability, bookings, and secure payment processing, integrating seamlessly with the Hotel Haven front-end.

Table of Contents


Getting Started

Prerequisites

  • PHP >= 8.3
  • Composer
  • MySQL or other database

Installation

  1. Clone this repository:

    git clone https://github.com/RenzAljon24/hotel-service.git
    cd hotel-service
  2. Install dependencies:

    composer install
  3. Set up the environment:

    • Copy .env.example to .env.
    • Update the .env file with your database and other configurations.
    php artisan key:generate
  4. Run migrations to set up the database:

    php artisan migrate
  5. Start the server:

    php artisan serve

Project Overview

The Laravel backend provides APIs for managing hotel reservations, user authentication, and payment processing. Key features include:

  • User Authentication: Register and log in users securely.
  • Room Management: CRUD operations for room availability and details.
  • Booking System: Handles room reservations and booking details.
  • Payment Processing: Processes secure payments through integrated payment gateways.

API Endpoints

Here's an overview of the main API endpoints. Detailed API documentation can be added as the project grows.

Method Endpoint Description
POST /api/register Register a new user
POST /api/login User login
GET /api/rooms List all available rooms
GET /api/rooms/{id} Get details of a specific room
POST /api/reservations Make a new booking
PUT /api/admin/rooms/{id} Update room details (Admin only)
DELETE /api/admin/rooms/{id} Delete a room (Admin only)

Environment Variables

Set the following environment variables in your .env file:

APP_NAME=HotelHavenBackend
APP_ENV=local
APP_KEY=base64:your-generated-key
APP_DEBUG=true
APP_URL=http://localhost

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=your_database
DB_USERNAME=your_username
DB_PASSWORD=your_password

# Add other relevant API keys and secrets here

Team

This project is a collaboration among:


License

This project is licensed under the MIT License.


This README provides a solid overview, installation steps, API details, and team credits, giving users or contributors clear guidance on working with the Laravel backend.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published