An open API service indexing awesome lists of open source software.

https://github.com/spcfictdu/hrbms-frontend

๐Ÿจ Modern hotel management system built with Vue.js and Vuetify. Features room management, guest booking portal, staff administration, payment processing, and reporting tools. Streamlines hotel operations from reservation to checkout.
https://github.com/spcfictdu/hrbms-frontend

css hotel hotel-booking hotel-management-system html javascript vue2 vuejs vuetify

Last synced: 3 months ago
JSON representation

๐Ÿจ Modern hotel management system built with Vue.js and Vuetify. Features room management, guest booking portal, staff administration, payment processing, and reporting tools. Streamlines hotel operations from reservation to checkout.

Awesome Lists containing this project

README

          

Hotel Room and Booking Management System

# ๐Ÿจ Introduction

A comprehensive Vue.js-based solution for hotel operations, providing seamless booking management, guest services, transaction processing, and reporting capabilities.

## ๐Ÿš€ Key Features

- ๐Ÿ›๏ธ Room inventory management and availability tracking
- ๐Ÿงณ Guest-facing booking portal with self-service options
- ๐Ÿ‘จโ€๐Ÿ’ผ Staff dashboard for booking administration
- ๐Ÿ’ณ Integrated payment processing system
- ๐Ÿ“Š Comprehensive reporting and analytics
- ๐Ÿ“ฑ Responsive design for all devices

## ๐Ÿ› ๏ธ Technologies Used

[![Vue.js](https://img.shields.io/badge/Vue.js-4FC08D?style=for-the-badge&logo=vue.js&logoColor=white)](https://vuejs.org/)
[![Vuetify](https://img.shields.io/badge/Vuetify-1867C0?style=for-the-badge&logo=vuetify&logoColor=white)](https://vuetifyjs.com/)
[![JavaScript](https://img.shields.io/badge/JavaScript-F7DF1E?style=for-the-badge&logo=javascript&logoColor=black)](https://developer.mozilla.org/en-US/docs/Web/JavaScript)
[![Node.js](https://img.shields.io/badge/Node.js-339933?style=for-the-badge&logo=nodedotjs&logoColor=white)](https://nodejs.org/)
[![HTML5](https://img.shields.io/badge/HTML5-E34F26?style=for-the-badge&logo=html5&logoColor=white)](https://developer.mozilla.org/en-US/docs/Web/HTML)
[![CSS3](https://img.shields.io/badge/CSS3-1572B6?style=for-the-badge&logo=css3&logoColor=white)](https://developer.mozilla.org/en-US/docs/Web/CSS)

## ๐Ÿ“ฆ Prerequisites

### 1. Required Software

- [NPM](https://nodejs.org/en/download)

### 2. ๐Ÿ”ง Configuration and Connectivity Setup

#### โœ… Critical Configuration Checklist

| Configuration | File / Location | Action Required |
| ------------------------ | --------------- | ---------------------------------------------------------------- |
| **API Endpoint** | `urls.js` | โœ… Set the correct backend API endpoint |
| **Backend URL** | `main.js` | ๐ŸŒ Set the correct backend hosting: **deployed, local, network** |
| **Backend Connectivity** | `hrbms-backend` | ๐Ÿ”— Ensure complete integration and successful communication |

#### โš ๏ธ Common Pitfalls

Misconfiguration can lead to:

- API connection failures
- Image loading issues
- Data synchronization issues

#### ๐Ÿ’ก Best Practices

- Double-check all endpoint URLs
- Test all connections in a staging environment before production
- Avoid hardcoding sensitive data; use the designated configuration files

## ๐Ÿ—๏ธ Project Architecture

```
hrbms-frontend/
โ”œโ”€โ”€ src/
โ”‚ โ”œโ”€โ”€ assets/ # Static assets like images, svgs
โ”‚ โ”œโ”€โ”€ components/ # Reusable Vue components
โ”‚ โ”œโ”€โ”€ mixins/ # Vue Mixins
โ”‚ โ”œโ”€โ”€ plugins/ # Vue plugins configuration
โ”‚ โ”œโ”€โ”€ router/ # Application routing
โ”‚ โ”œโ”€โ”€ store/ # Vuex state management
โ”‚ โ”œโ”€โ”€ utils/ # Helper functions and utilities
โ”‚ โ”œโ”€โ”€ views/ # Page components
โ”‚ โ”œโ”€โ”€ App.vue # Root component
โ”‚ โ””โ”€โ”€ main.js # Entry point
โ””โ”€โ”€ public/ # Public static assets
```

The application follows a modular architecture with clear separation of concerns:

- **Presentation Layer**: Vue.js components and Vuetify UI framework
- **State Management**: Centralized Vuex store for application data
- **Service Layer**: API integration and third-party services
- **Utility Layer**: Helper functions and shared logic

## ๐Ÿš€ Project Setup

### Install Dependencies

```bash
npm install # ๐Ÿ“ฆ Installs all required node modules
```

### Available Commands

| Command | Description |
| --------------- | ------------------------------------------------ |
| `npm run serve` | ๐Ÿ”ง Start in development mode with hot-reload |
| `npm run build` | ๐Ÿ“ฆ Build for production (minified and optimized) |
| `npm run lint` | ๐Ÿงน Lint and fix code issues |

## ๐Ÿ” Troubleshooting Guide

### API Connection Issues

| Issue | Solution |
| --------------------------- | ------------------------------------------------------------ |
| API timeout errors | Check network connectivity and backend server status |
| Authentication failures | Verify correct API credentials in `urls.js` |
| CORS errors | Ensure backend has proper CORS configuration for your domain |
| Data synchronization issues | Check local storage quota and clear cache if necessary |
| Image loading issues | Verify correct API endpoint in url `urls.js` |

## ๐Ÿ“‹ Commit Message Guidelines

Use the following emojis to indicate the nature of your commits:

| Emoji | Code | Description |
| ----- | ----------------------------- | --------------------------------- |
| ๐Ÿ’ฏ | `:100:` | Full functionality implementation |
| ๐Ÿ”ง | `:wrench:` | Code improvement / refactor |
| ๐Ÿ› | `:bug:` | Bug fix |
| ๐Ÿ“‘ | `:bookmark_tabs:` | Documentation and comments |
| โ˜• | `:coffee:` | Minor or initial changes |
| ๐Ÿšง | `:construction:` | Work in progress |
| ๐Ÿ—‘๏ธ | `:wastebasket:` | Code or file deletion |
| ๐Ÿ““ | `:notebook:` | README updates |
| โœ๏ธ | `:pencil2:` | Typo or naming corrections |
| โ™ป๏ธ | `:recycle:` | Code refactoring |
| ๐Ÿ”€ | `:twisted_rightwards_arrows:` | Branch merge |
| โช | `:rewind:` | Reverting changes |
| ๐Ÿ“ฑ | `:iphone:` | Responsive design changes |
| ๐Ÿ“Œ | `:pushpin:` | Hotfixes |

## ๐Ÿค Contributing Guidelines

### Branch Naming

- `developer`: For main development
- `feature/feature-name`: For new features
- `hotfix/issue-name`: For critical fixes
- `release/version`: For release preparation

### Code Style

- Follow Vue.js style guide
- Use ESLint configuration
- Write meaningful comments

## ๐Ÿ”’ Security Considerations

- All API requests must use HTTPS
- Sensitive data must be encrypted at rest and in transit
- User authentication tokens should be stored securely
- Implement proper input validation to prevent injection attacks
- Regular security audits are conducted on the codebase

> For security issues, please contact the security team at `spcf.ictdu@spcf.edu.ph`.

## ๐Ÿ‘ฅ Development Team

- ๐Ÿ‘จโ€๐Ÿ’ป **Gabriel Alfonso M. Gatbonton** - Senior Frontend Developer
- ๐Ÿ‘จโ€๐Ÿ’ป **Prince Charles M. Clemente** - Senior Frontend Developer
- ๐Ÿ‘จโ€๐Ÿ’ป **Rhymeses E. Cortez** - Junior Frontend Developer