README.md

Hotel PMS Website

A website for Hotel Property Management System (PMS).

Tech Stack

• React: Utilizing shadcn for components, lucid-react for icons, and react-router-dom for routing.
• Laravel: Leveraging ORM, artisan, composer, RESTful API, middlewares, and a design system.
• Package Management: Utilizing pnpm and npm.
• Build Tool: Vite.

Development Tools

• IDE: neovim and VS Code.
• Git Workflow: Trunk Based Development.

Installation

1. Clone the repository.

2. Install project dependencies using either pnpm or npm.

   # Using pnpm
   pnpm install
   
   # Using npm
   npm install

Usage

1. Start the development server.

   # Using pnpm
   pnpm dev
   
   # Using npm
   npm run dev
   ```
   

2. Open your browser and visit http://localhost:3000 to access the website.

Additional Information

• The React components in this project leverage the shadcn library for styling and lucid-react library for icons.
• Routing is handled using the react-router-dom package to enable seamless navigation within the application.
• Laravel is used on the server-side, providing features like ORM, artisan command-line tool, composer for package management, RESTful API development, middlewares, and a design system.
• The project follows the Trunk Based Development workflow for efficient collaboration and continuous integration.
• Developers can choose to use either neovim or VS Code as their main IDE for this project.