Good_Reads

Good Reads is an app for book lovers to discover new books, track their reading progress, and maintain a personal library.

Table of Contents

1. Screenshots
2. Features
3. Built With
4. Architecture
5. Package Structure
6. Installation
7. Contributing
8. License

---

📸 Screenshots

Here's a glimpse of the Good Reads app in action!

                                                 

🌟 Features

• User Authentication: Secure login and sign-up functionality using Firebase.
• Explore Books: Browse and search for books using the Google Books API.
• Book Details: View detailed information about each book.
• Reading List: Add books to your personal reading list.
• Track Progress: Update the status of your books to "Reading," "Read," or "Not Yet."
• Rate Books: Rate the books you have read.
• Reading Stats: Get insights into your reading habits.

🛠 Built With

• Kotlin - The official programming language for Android development.
• Coroutines - For asynchronous programming.
• Jetpack Compose - Android’s modern toolkit for building native UI.
• Android Architecture Components - A collection of libraries for robust, testable, and maintainable apps.
  • ViewModel - Manages UI-related data in a lifecycle-conscious way.
  • Navigation Component - For navigating between screens.
• Dependency Injection
  • Hilt-Dagger - For dependency injection.
• Retrofit - A type-safe HTTP client for Android.
• Coil-kt - An image loading library for Android backed by Kotlin Coroutines.
• Firebase
  • Authentication - For user login and registration.
  • Firestore - As a cloud database to store user data and book lists.
• Material Components for Android - Modular and customizable Material Design UI components for Android.
• Gradle Kotlin DSL - For writing Gradle build scripts using Kotlin.

🏛️ Architecture

Good Reads is based on MVVM (Model View View-Model) architecture and the repository pattern.

📦 Package Structure

    🌐com.example.good_reads   # Root Package
    .
    ├──🔌components             # Reusable UI components.
    |
    ├── 📁data                # Handles data operations.
    |
    ├── 💉di                  # Dependency Injection related classes.
    |
    ├── 👤model               # Defines the data models for the app.
    |
    ├── 🗺️navigation          # Manages navigation between screens.
    |
    ├── ☁️network             # Handles network requests.
    |
    ├── 📚repository          # Manages data sources.
    |
    ├── 🖼️screens                # Contains the different screens of the app.
    |
    ├── 🎨ui.theme               # Theming and styling of the app.
    |
    └── 🔧utils               # Utility classes and functions.

---

⬇️ Installation

To get started with Good Reads, follow these steps:

1. Clone the repository.
2. Open the project in Android Studio.
3. Run the application on your device or emulator.
4. Set up a Firebase project and replace the google-services.json file with your own.

🙋 Contributing

We welcome contributions! Feel free to open an issue or submit a pull request.

📝 License

Good Reads is released under the MIT License.

---

Happy Reading! 🎉