Skip to content

PaMuGr/HolyQuotes

Repository files navigation

📖 QuoteApp - Bible Verses

A beautiful Android app built with Jetpack Compose that displays inspirational Bible verses with swipe gestures and favorites functionality.

📒 Index

🔰 About

QuoteApp is a Android application designed to provide daily inspiration through Bible verses. Built with Jetpack Compose and Material Design 3, it offers a seamless user experience with intuitive swipe gestures, favorites management, and social sharing capabilities.

⚡ Usage

The app is simple and intuitive to use:

  1. Swipe Navigation: Swipe left/right to browse through different Bible verses
  2. Favorites: Tap the heart icon to add/remove verses from favorites
  3. Sharing: Use the share icon to share verses with others
  4. Tabs: Switch between "Versículos" and "Favoritos" tabs

🔌 Installation

  • Coming soon

🔧 Development

We welcome contributions from the developer community! See Development Environment!

📓 Pre-Requisites

  • Android Studio (Arctic Fox or later)
  • Android SDK (API 21+)
  • Java 17 or higher
  • Git for version control

🔩 Development Environment

  1. Clone the repository

    git clone https://github.com/YOUR_USERNAME/QuoteApp.git
    cd QuoteApp
    
  2. Open in Android Studio

  • Open Android Studio
  • Select “Open an existing project”
  • Navigate to the cloned QuoteApp folder
  1. Sync and Build
  • Android Studio will automatically sync Gradle files
  • Build the project (Build → Make Project)

📁 File Structure

Add a file structure here with the basic details about files, below is an example.

QuoteApp/
├── app/
│   ├── src/main/
│   │   ├── java/com/example/quoteapp/
│   │   │   ├── data/              # Data sources and static data
│   │   │   │   └── QuotesDataEn.kt
│   │   │   │   └── QuotesDataEs.kt
│   │   │   ├── model/             # Data models
│   │   │   │   └── Quote.kt
│   │   │   ├── repository/        # Data handling logic
│   │   │   │   └── QuoteRepository.kt
│   │   │   ├── ui/               # UI components
│   │   │   │   ├── main/         # Main screen components
│   │   │   │   │   ├── ConfigurationScreen.kt
│   │   │   │   │   ├── FavoritesScreen.kt
│   │   │   │   │   ├── MainActivity.kt
│   │   │   │   │   ├── MainScreen.kt
│   │   │   │   │   ├── Preview.kt
│   │   │   │   │   ├── QuotesComponents.kt
│   │   │   │   │   └── QuotesScreen.kt.kt
│   │   │   │   └── theme/        # Theme and styling
│   │   │   │       ├── Color.kt
│   │   │   │       ├── Theme.kt
│   │   │   │       └── Type.kt
│   │   │   └── utils/            # Utility functions
│   │   │       ├── ShareUtils.kt
│   │   │       └── Constants.kt
│   │   ├── res/                  # Resources
│   │   │   ├── values/
│   │   │   ├── layout/
│   │   │   └── drawable/
│   │   └── AndroidManifest.xml
│   └── build.gradle.kts
├── gradle/
└── README.md
No File/Folder Details
1 ui/main/ Main application screens and components
2 data/ Static data and data sources
3 repository/ Data handling and business logic
4 model/ Data models and structures
5 ui/theme/ App theme, colors, and typography

🔨 Build

./gradlew assembleDebug

🚀 Deployment

./gradlew assembleRelease

🔥 Contribution

Your contributions are always welcome and appreciated. Following are the things you can do to contribute to this project.

  1. Report a bug
    If you think you have encountered a bug, and I should know about it, feel free to report it and I will take care of it.

  2. Request a feature
    You can also request for a feature

  3. Create a pull request
    It can't get better then this, your pull request will be appreciated

❗ Guideline

  • Follow Kotlin coding conventions
  • Use meaningful variable names
  • Write clean, readable code
  • Add comments for complex logic
  • Test on multiple screen sizes
  • Follow Material Design 3 guidelines

📄 Resources

📷 Gallery

Coming Soon

🌟 Credit/Acknowledgment

https://github.com/PaMuGr

About

Android Bible Quotes App with Jetback Compose

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages