Skip to content

A cross-platform restaurant application built with Next.js and Capacitor. Users can browse the menu, place orders, track them in real time, and enjoy features like authentication, onboarding, map integration, and a responsive design.

License

Notifications You must be signed in to change notification settings

beydah/Coffee-Mobile-App

Repository files navigation

☕ Coffee Mobile App - Enterprise Mobile Experience

Production Build Architecture License: MIT

An enterprise-grade, high-performance boutique coffee mobile application built with Next.js 15, Capacitor 7, and Atomic Design principles.


🏗 Architectural Overview

This project follows a Modular Monolithic structure with Regional Governance to ensure extreme scalability and maintainability.

Regional Registers

Region Purpose Governance
app/ Routing & Layout Next.js App Router
frontend/ UI Components Atomic Design (atoms, molecules, organisms)
backend/ Business Logic Modular Services (auth, product, order)
core/ Cross-Cutting Shared Contexts, Constants, & Utilities
configs/ System Level Env Validation & Project Settings

🏷 Naming & Governance

We follow a strict, searchable, and professional naming convention to ensure code clarity.

Prefixes & Conventions

Category Convention Example
Files snake_case auth_service.ts
Components F_Pascal_Snake F_Login_Form
Props p_snake_case p_on_click_handler
Types/Interfaces I_Pascal_Snake I_User_Profile
Services/Classes C_UPPER_SNAKE C_AUTH_SERVICE
Variables/Flags snake_case_flag is_authenticated_flag

Important

All imports must use the @/ absolute alias. Files in frontend/ cannot import directly from backend/; they must use core/ bridges.


🛠 Tech Stack


🚀 Getting Started

Prerequisites

  • Node.js 20+
  • npm 10+
  • Android Studio (for Android builds)

Installation & Setup

# 1. Clone the repository
git clone [repository-url]

# 2. Install dependencies
npm install

# 3. Environment setup
cp .env.example .env

# 4. Run development server
npm run dev

👷 Contribution Standards

  1. Regional Governance: Never cross boundaries. UI logic stays in frontend/, Business in backend/.
  2. Atomic Design:
    • Atoms: Stateless single-tag units (F_Button).
    • Organisms: Complex sections composed of atoms (F_Top_Nav).
  3. Commit Messages: Follow Conventional Commits.

See the full Contribution Guide for detailed standards.


📦 Roadmap

🟢 Quick Wins

  • Zod Env Validation
  • React Error Boundaries for specific content regions
  • Native Splash Synchronization

🟡 Mid-Term

  • Real API Integration (Axios/Fetch)
  • TanStack Query Migration
  • Centralized UI Tokens

🔴 Major Refactors

  • Monorepo Migration (Turborepo)
  • MSW Integration for offline dev
  • Storybook Deployment

⚖️ License

Distributed under the MIT License. See LICENSE for more information.

About

A cross-platform restaurant application built with Next.js and Capacitor. Users can browse the menu, place orders, track them in real time, and enjoy features like authentication, onboarding, map integration, and a responsive design.

Topics

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Contributors 2

  •  
  •