Skip to content

bladerjam7/CookCompass

Repository files navigation

Cook Compass 🍳

⚠️ Status: Not completed

Cook Compass is a clean, modern Android recipe app that helps users discover, save, and manage their favorite recipes in one place. The app focuses on a simple, intuitive UI and a delightful cooking experience.

✨ Features

  • 📋 My Recipes – View all saved recipes in a beautiful card-based layout
  • Add Recipe – Create and store your own custom recipes
  • 🖼️ Recipe Images – Each recipe includes a featured image
  • ⏱️ Cook Time – Quick visibility into how long a recipe takes
  • 👥 Servings – See how many people the recipe serves
  • 🎯 Difficulty Levels – Easy, Medium, or Hard
  • 🏷️ Tags & Categories – Organize recipes (e.g., Pasta, Italian, Breakfast)
  • Recipe Actions – Edit or delete recipes via overflow menu

📱 Screenshots

My Recipes Screen
image image image

🏗️ Tech Stack

  • Language: Kotlin
  • UI: Jetpack Compose
  • Architecture: MVVM (Model–View–ViewModel)
  • State Management: State / Flow
  • Navigation: Jetpack Navigation Compose

🧱 Architecture

Cook Compass follows MVVM best practices:

  • Model: Recipe data models and repository layer
  • View: Jetpack Compose UI
  • ViewModel: Holds UI state and business logic

This separation ensures:

  • Testability
  • Scalability
  • Clear separation of concerns

📂 Project Structure

app/
├── model/
├── ui/
│   ├── screens/
│   ├── components/
│   └── theme/
└── MainActivity.kt

🚀 Getting Started

Prerequisites

  • Android Studio Hedgehog or newer
  • Android SDK 24+

Installation

  1. Clone the repository:

    https://github.com/bladerjam7/CookCompass.git
  2. Open the project in Android Studio

  3. Sync Gradle

  4. Run on an emulator or physical device

🎨 Design Philosophy

  • Minimal, distraction-free UI
  • Large recipe imagery
  • Clear typography and spacing
  • Touch-friendly actions

Inspired by modern Material Design and cooking apps.

🛣️ Roadmap

  • 🔍 Recipe search & filtering
  • ☁️ Cloud sync
  • ❤️ Favorites
  • 📦 Ingredient-based recommendations
  • 🤖 AI-assisted recipe generation

Made with ❤️ using Kotlin & Jetpack Compose

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages