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

https://github.com/jayhawk24/bello

Bello s a web based concierge for hotels and accommodations for easy access to room service
https://github.com/jayhawk24/bello

Last synced: 10 months ago
JSON representation

Bello s a web based concierge for hotels and accommodations for easy access to room service

Awesome Lists containing this project

README

          

# ๐Ÿจ Bello - Hotel Concierge Service Platform

A comprehensive Next.js full-stack application providing premium concierge services for hotel guests with a subscription-based model.

## โœจ Features

### ๐ŸŽจ Design

- **Minion-inspired Yellow Theme** - Playful, bright, and welcoming design
- **Responsive Design** - Works seamlessly on all devices
- **Modern UI Components** - Custom styled components with smooth animations

### ๐Ÿ‘ฅ User Roles

- **Super Admin** - System-wide management and analytics
- **Hotel Admin** - Hotel and staff management, room configuration
- **Hotel Staff** - Service request handling and guest assistance
- **Guest** - Service access via QR codes or booking IDs

### ๐Ÿš€ Core Functionality

- **QR Code Access** - Guests scan room QR codes for instant access
- **Service Requests** - Room service, housekeeping, transportation, recommendations
- **Real-time Updates** - Live status tracking and notifications
- **Subscription Management** - Flexible pricing tiers with Razorpay integration
- **Analytics Dashboard** - Comprehensive insights and reporting

## ๐Ÿ›  Technology Stack

- **Frontend**: Next.js 14, React, TypeScript
- **Styling**: Tailwind CSS with custom minion theme
- **Backend**: Next.js API routes
- **Database**: PostgreSQL with Prisma ORM
- **Authentication**: NextAuth.js (planned)
- **Payments**: Razorpay integration (planned)
- **Real-time**: WebSockets for notifications (planned)

## ๐Ÿš€ Getting Started

### Prerequisites

- Node.js 18+
- npm or yarn
- PostgreSQL database (for production)

### Installation

1. **Clone the repository**

```bash
git clone
cd bello
```

2. **Install dependencies**

```bash
npm install
```

3. **Start development server**

```bash
npm run dev
```

4. **Open in browser**
```
http://localhost:3000
```

## ๐Ÿ“ Project Structure

```
src/
โ”œโ”€โ”€ app/
โ”‚ โ”œโ”€โ”€ (auth)/ # Authentication routes (login, register)
โ”‚ โ”œโ”€โ”€ guest/ # Guest access routes (QR scan, booking ID)
โ”‚ โ”œโ”€โ”€ dashboard/ # Role-based dashboards (planned)
โ”‚ โ”œโ”€โ”€ api/ # API endpoints (planned)
โ”‚ โ””โ”€โ”€ globals.css # Global styles and theme
โ”œโ”€โ”€ components/ # Reusable UI components (planned)
โ”œโ”€โ”€ lib/ # Utility functions and configurations (planned)
โ””โ”€โ”€ types/ # TypeScript type definitions (planned)
```

## ๐ŸŽฏ Development Phases

### โœ… Phase 1: Foundation (Current)

- [x] Next.js 14 setup with TypeScript
- [x] Tailwind CSS with minion-inspired theme
- [x] Landing page with pricing tiers
- [x] Basic authentication UI (login/register)
- [x] Guest access UI (QR scan/booking ID)

### ๐Ÿ”„ Phase 2: Authentication & User Management (Next)

- [ ] NextAuth.js setup
- [ ] User registration with email verification
- [ ] Role-based authentication middleware
- [ ] Password reset functionality

### ๐Ÿ“‹ Phase 3: Hotel Management System

- [ ] Hotel admin dashboard
- [ ] Room configuration and QR code generation
- [ ] Staff management interface
- [ ] Hotel profile setup

### ๐Ÿ›Ž๏ธ Phase 4: Guest Access System

- [ ] QR code scanning implementation
- [ ] Booking ID verification
- [ ] Guest session management
- [ ] Temporary vs registered guest accounts

### ๐Ÿ”ง Phase 5: Service Request System

- [ ] Service catalog management
- [ ] Request workflow (pending โ†’ in-progress โ†’ completed)
- [ ] Staff assignment logic
- [ ] Real-time status notifications

### ๐Ÿ’ณ Phase 6: Subscription & Payments

- [ ] Razorpay integration
- [ ] Subscription plan management
- [ ] Billing and invoice generation
- [ ] Plan upgrade/downgrade flows

### ๐Ÿ“Š Phase 7: Analytics & Reporting

- [ ] Occupancy rate tracking
- [ ] Revenue analytics (RevPAR, ADR)
- [ ] Guest satisfaction metrics
- [ ] Service performance insights

### โšก Phase 8: Real-time Features

- [ ] WebSocket implementation
- [ ] Live notifications
- [ ] Chat support system
- [ ] Push notification setup

## ๐ŸŽจ Theme & Design System

### Colors

- **Primary**: `#FFD700` (Minion Yellow)
- **Secondary**: `#2196F3` (Minion Blue)
- **Success**: `#4CAF50`
- **Warning**: `#FF9800`
- **Error**: `#F44336`

### Components

- **Buttons**: `.btn-minion`, `.btn-minion-secondary`
- **Cards**: `.card-minion`
- **Inputs**: `.input-minion`
- **Animations**: `.animate-bounce-slow`, `.animate-fade-in`

## ๐Ÿ“š Documentation

- [Project Requirements](./PROJECT_REQUIREMENTS.md) - Detailed feature specifications
- [Development Instructions](./DEVELOPMENT_INSTRUCTIONS.md) - Development guidelines and standards
- [AI Instructions](./.github/copilot-instructions.md) - AI coding agent guidelines

## ๐Ÿ” Environment Variables

Create a `.env.local` file with:

```env
# Database
DATABASE_URL="postgresql://..."

# NextAuth
NEXTAUTH_SECRET="your-secret-key"
NEXTAUTH_URL="http://localhost:3000"

# Razorpay
RAZORPAY_KEY_ID="your-key-id"
RAZORPAY_KEY_SECRET="your-key-secret"
```

## ๐Ÿงช Testing

```bash
npm run test # Run tests (planned)
npm run test:e2e # Run E2E tests (planned)
npm run type-check # TypeScript type checking
npm run lint # ESLint checks
```

## ๐Ÿš€ Deployment

```bash
npm run build # Build for production
npm start # Start production server
```

## ๐Ÿ“ž Support

For questions or support:

- Create an issue in this repository
- Contact the development team
- Check the documentation files

---

Built with โค๏ธ using Next.js, TypeScript, and a touch of minion magic! ๐ŸŒ