Skip to content

An Android Application to show details on the best-selling books based on the New York Times ratings

Notifications You must be signed in to change notification settings

EddyMM/bookworm

Repository files navigation

CircleCI

Bookworm

An Android Application to show details on the best-selling books based on the New York Times ratings.

google_play_icon Get it on Google Play using this link

intro categories book list book detail

Getting Started

To run this project, do the following:

  1. Clone the project
  2. Open the project from Android Studio
  3. Get an API KEY for books api from here
  4. Ensure you have installed NDK, CMake and LLDB as shown in the developer page
  5. Add a folder named 'native' in the data/src/main
  6. Create a C++ file named native-lib.cpp inside the native folder
  7. Add the following C++ code to it. Replace the <API_KEY> with a base64 encoded version of the API key you obtained
#include <jni.h>

extern "C" {

    JNIEXPORT jstring JNICALL
    Java_com_eddy_data_rest_BooksApi_getAPIKey(JNIEnv *env, jclass type) {
        return env-> NewStringUTF("<API_KEY>");
    }
}

Prerequisites

  • Android Studio IDE
  • Gradle

Installing

  • Clone the project
git clone https://github.com/EddyMM/bookworm.git
  • Open project using Android Studio
  • Sync with gradle files to get the necessary dependencies
  • Run the project using emulator or connected Android Device

Built With

  • Android SDK
  • Gradle - Dependency Management
  • Retrofit as a REST client library
  • Picasso for image loading and caching
  • FirebaseAuth - User Authentication
  • Firebase Realtime Database - Data persistence

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -m 'Add some feature')
  4. Push your branch (git push origin my-new-feature)
  5. Create a new Pull Request

Authors

License

This project is licensed under the MIT License - see the LICENSE.md file for details