Skip to content

Sanskar-Rijal/S-Reader

Repository files navigation

S. Reader

Overview

The S. Reader is a comprehensive book management application designed for book enthusiasts. It allows users to track their reading journey, maintain a collection of books, rate and review them, and discover new reads. The app provides a seamless user experience, leveraging modern Android development tools like Kotlin and Jetpack Compose.

Features

  • Track Your Reading: Mark books as "Currently Reading," "Want to Read," or "Finished Reading."
  • Ratings and Reviews: Rate books and leave reviews.
  • Book Details: View detailed information about each book, including the title, author, description, categories, and more.
  • Firebase Integration: All user data, including reading progress and ratings, are synced in real-time with Firebase.
  • User Authentication: Secure login and signup using Firebase Authentication.
  • Dynamic UI: Modern and dynamic UI using Jetpack Compose, with smooth animations and responsive layouts.
  • Offline Support: View your saved books even when offline.

Technology Stack

  • Language: Kotlin
  • UI Framework: Jetpack Compose
  • Backend: Firebase Realtime Database & Firestore
  • Authentication: Firebase Authentication
  • Image Loading: Coil
  • Testing: JUnit & MockK

How to Run the App

  1. Clone this repository:
    git clone https://github.com/yourusername/goodreads-clone.git
    cd goodreads-clone
  2. Open the project in Android Studio.
  3. Sync the Gradle files and make sure all dependencies are installed.
  4. Set up your Firebase project:
    • Go to the Firebase Console.
    • Create a new project and add an Android app.
    • Download the google-services.json file and place it in the app directory.
  5. Build and run the app on an emulator or physical device.

Contribution Guidelines

We welcome contributions! To contribute:

  1. Fork this repository.
  2. Create a feature branch:
    git checkout -b feature-name
  3. Commit your changes and push them to your fork.
  4. Create a pull request, describing your changes in detail.

Acknowledgements

This app was inspired by the GoodReads platform, aiming to provide a similar experience with additional customizations and a modern Android tech stack. Thanks to all open-source libraries and tools that made this project possible.

Future Enhancements

  • Add a social feature to follow other users and see their reading lists.
  • Implement advanced search filters.
  • Integrate APIs for book recommendations.
  • Add support for dark mode.

ScreenShots

About

Book app just like good reads

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages