CoffeShop - Mobile Application

CoffeShop is a modern, cross-platform mobile application built with React Native and Expo, designed to provide a seamless coffee ordering experience.

📖 Table of Contents

• Project Overview
• Features
• Tech Stack
• Installation
• Usage
• Environment Variables
• Folder Structure
• 📚 Documentation
• Contributing
• Security
• License
• Author

🚀 Project Overview

CoffeShop aims to revolutionize the way customers interact with their favorite coffee spots. Built for both iOS and Android, it leverages the power of Expo to deliver a high-performance, native-like experience.

✨ Features

• Cross-Platform: Runs smoothly on both iOS and Android devices.
• Intuitive UI: Designed with a focus on user experience and ease of use.
• Fast Performance: Optimized for speed and responsiveness.
• File-Based Routing: Utilizes Expo Router for simplified navigation logic.

🛠 Tech Stack

• Framework: React Native (v0.76.2)
• Platform: Expo (~52.0.9)
• Routing: Expo Router (~4.0.7)
• Language: TypeScript / JavaScript
• Testing: Jest, Jest-Expo

📥 Installation

Follow these steps to set up the project locally.

Prerequisites

• Node.js (LTS recommended)
• npm or yarn
• Expo CLI (npm install -g expo-cli)

Steps

1. Clone the repository:

   git clone https://github.com/MDF05/MDFCoffeeShop.git
   cd MDFCoffeeShop

2. Install dependencies:

   npm install

3. Start the development server:

   npx expo start

📱 Usage

After starting the server:

• Android: Press a in the terminal to open in Android Emulator.
• iOS: Press i in the terminal to open in iOS Simulator (macOS only).
• Web: Press w in the terminal to run in the browser.

🔑 Environment Variables

Create a .env file in the root directory to configure the application. See ENVIRONMENT.md for details.

📂 Folder Structure

CoffeShop/
├── app/                 # Expo Router application code
├── assets/              # Static assets (images, fonts)
├── components/          # Reusable React components
├── constants/           # Global constants and config
├── hooks/               # Custom React hooks
├── scripts/             # Utility scripts
├── src/                 # Source code
├── .env                 # Environment variables
├── app.json             # Expo configuration
├── package.json         # Dependencies and scripts,
└── README.md            # Project documentation

📚 Documentation

For detailed information, please refer to the specific documentation files below:

• Architecture
• API Documentation
• Database Schema
• Deployment Guide
• Environment Configuration
• Testing Guide
• Style Guide
• Contributing Guide
• Code of Conduct
• Security Policy
• Governance
• Support
• Roadmap
• Changelog
• Disclaimer
• License

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details on how to get started.

🔒 Security

For security vulnerabilities and reporting, please verify our Security Policy.

📄 License

This project is proprietary software. See the LICENSE file for details.

✍️ Author

Muhammad Dava Fahreza

• Owner of CoffeShop