Books (working name)

Table of content

• Books
  • Table of content
  • About Project
  • For Who
  • About us
    • Team
  • Our goal
  • MVP (Minimum Viable Product)
    • Create Library
    • Add book
    • Display list of books (Library Screen)
    • Edit Book
    • Remove Book
    • Searching Book
    • Filtering Books
    • Importing books & Exporting books
  • Planned Features
  • What do we use?
  • Contribution Guide
    • Found a bug?
    • Have a feature idea?
    • Do you want to code?

About Project

Books is an android application that allow user to store information about books they owe or they've read. It will allow to save basic book data like title, authors, category along with description or summary created by the user and personal rank.

In the future it will allow users to share their libraries with friends and people nearby. They will be able to easily find and read reviews of book that would like to buy or read or even to borrow book from friends.

For who

This application is for all of you that read a lot of books and want to easily store key thoughts about your readings. The idea of this application belongs to @MichaelB-pl whose wife loves to read.

About us

We are group of developers connected by **Google Developer Challenge Scholarship - Android Developer track**. We decided to work together to create great open-sourced app and learn from each other.

Team

Natalia Jastrzębska

Karol Lisiewicz

Michał Bachta

Adam Świderski

Our goal

As we mentioned our main goal is to learn new thing. That is why we pay a lot of attention to our architecture. We use MVVM with Android Architecture Components, LiveData, Room. Most of the time we use google samples as our guide.

MVP (Minimum Viable Product)

We decided that our MVP will be offline(without backend) app containing following features:

Create Library

This screen allows user to create his library by providing a name. In future it will be transformed to Login Screen.

Add book

This screen allows user to add new book by providing link to cover image, title, authors, category and description.

Display list of books (Library Screen)

It's main screen of app where whole library is displayed: book cover along with title and authors.

Display book details

In this screen user can preview more details of book such as: category, description.

Edit book

This screen allows user to edit book data.

Remove book

Option of removing book is available in Libarary Screen by swiping book and in Edit screen.

Searching book

Option of searching book is available in Library Screen in toolbar.

Filtering books

Option of filtering books is available in Library Screen by using dropdown menu.

Importing books and Exporting books

App allows users to export whole library to CSV file and import library from CSV. It's needed mostly while app doesnt store anything in cloud.

Planned features

• Adding Firebase
• Registering users
• Login&Logout users
• Storing user informations
• Using Google Api Books
• Scanning books bar codes
• Adding posibility of preview user libraries created by other users
• List to store list of books to read

What do we use?

• ButterKnife
• Glide
• Dagger
• SuperCSV
• RxJava, RxAndroid
• Room
• LiveData
• ViewModel

Contribution Guide

Found a bug?

If you want to repoort a bug or share suggestion feel free to Create an Issue.

Have a feature idea?

If you have an idea for a fetaure and you'd like to see it in our app, you're welcome to Create an Issue as well.

Do you want to code?

That's awesome! Everyone is welcome to contribute!

• Browse issue list and claim chosen one in comments. (If you can't find anything but have an idea, create an issue first and there you are.)
• Fork books repository.
• Code your changes.
• When you finished create PR to develop branch.