COSC 310 - Group 30 - Library Managment System

Welcome to our library managment system! Below is useful information about our app.

System Specifications

The library app will allow users and staff to interact with the library’s inventory. The system will consist of a number of features with the first being an account feature where customers can make unique accounts and log in with them. Employees have access to a different account that allows access to features that users should not have access too. Next, the app will have a database that tracks new users and books the library has. The database will track the book’s name, author, genre, id, whether it is checked out or not, who has the book checked out. Users will be able to search for books based on keywords and withdraw books that are currently in stock. Users are able to return books and are notified of the time until overdue. Users can see what books they have checked out at any given time. Users can also report damages of any books and notify admins of the issue. Users can review books after they’ve returned it and view other people’s reviews. Admins can search for specific books and see who is borrowing it. Admins can also add new books to the database and delete any if needed. Admins can also respond to and resolve report tickets. Users should also be able to view the most recent New York Times Best Sellers and find nearby libraries.

Feature Specifications

• Account

  Users should be able to create a unique account, login with it and be able to logout. Admins should be able to login with their credentials and logout.

• Database

  Stores book information (ID, title, author, genre, checkout status, customer ID) and customer information (ID, first name, last name).

• Search

  A spinner that filters by the user’s input and displays book if criteria matches

• Bookview

  Users can see what book they took out, report damage with a button and review button that brings the user to a review page

• Report

  Users can make a ticket for damaged books. Admins can see active tickets and resolve them.

• Review

  Users can write reviews and rate books upon returning it. Users should be able to see reviews

• Recent Arrivals

  Users can view the list of recent New York Times Bestsellers books.

• Nearby Libraries

  Users should be able to locate nearby libraries.

Iteration 1 Specifications and Limitations

• Basic Login

  A single account for users and a single account for admins that gives access to different views. Both can logout. No new accounts for this iteration

• Home Screen

  The user screen has My Books button and Search Books button. The admin screen will just have a Manage Books button

• Database

  The database will be primitive, consisting of a local file generated on the phone upon installation. It will have 30 books on install and admins will be able to add or delete books.

• User My Books

  A table that displays all the users checked out books and information. A check in button will be present that allows the user to “put back” a book.

• User Search

  Displays all available books and has a checkout button to checkout book.

• Admin Manage Books

  Displays all available books with a delete button available. An add button at the top should bring the admin to an add books page

• Admin Add Book

  Brings up a form for the admin to fill out

Iteration 2 Specifications and Limitations

• Advanced Login

  Users can now create different accounts that will save books specifically to them. Admin only has 1 universal account. Accounts are limited to a local device. Future iterations could utilize a cloud base system for accounts.

• Search

  Users can now search for a specific book, author, or genre within the user search page.

• Report System

  Users can now report damages on a certain book and include a description. Admins can view reported damage tickets and resolve them.

• Advanced Book View

  Users can now click on a book to view more in depth information

• Descriptions

  Books now have descriptions that give a brief summary of what it is about. Admin must now give a description when adding a book.

• Open Source Libraries

  • Calligraphy

  Allows for custom fonts that improve the look of buttons and text in a fast manner

  • Dynamic Toasts

  Improves the look of toast messages to provide better feedback to the user

Iteration 3 Specifications (APIs)

• New York Times Books API

  Users now have access to the New Arrivals button which takes them to a page of the list of books from the latest New York Times Best Sellers List. It uses the RetroFit Library to convert the JSON returned by the API into a Java Object.

  • JSON Objects Package

    Stores the various Objects used to hold the JSON Information.
    • Books
      Holds specific book information.
    • Lists
      Holds a specific list with an array of books.
    • Results
      Holds the list of Lists.

  • NYT Best Sellers Book

    Holds the number of results and the Results Object

  • NYT Best Sellers API

    Queries the lists overview with the api key and the requested query date. It is called by the Recent Books class.

  • Recent Books

    Creates the Retrofit build and calls the New York Times Books API, recieves the information, and uses the set up Object classes to access and format the data to be printed in the app. If there is a failure, an error code or message will print instead. Also allows access to Nearby Libraries.

• Google Maps API

  Users can now create different accounts that will save books specifically to them. Admin only has 1 universal account. Accounts are limited to a local device. Future iterations

  • Libraries Nearby

    Opens a google map focused on Kelowna with a button that allows users to click through the various libraries located in and around Kelowna. Also allows user to zoom in and out, and upon clicking on the pin allows the opening of the google maps app for directions.

Class Organization

All classes function as activities within the android studio project. We have additional objects used to store data including: Book (stores book info), Booklist (A list of current books), ReportObj (Reported damage), ReportList (List of reports), Account (Stores login info for user) and AccountList (List of all accounts). With the addition of APIs, the JSON Objects Package contains new Object classes Books, Lists, and Results, NYTBestSellersBook is also an object class and NYTBestSellersAPI an interface.

Installation Instructions

System Requirements:

• Android device with an internet connection

Installation:

1. Allow your browser to install unknown apps. For additional help on this, follow these instructions
2. Download the APK file from the APK folder
3. Enjoy!

Running the application

• Create an account to access user functionality.
  • Type in a username and password and press create account
  • To view admin, type in the following credentials
    • Username: admin
    • Password: pass

Team Members

• Ethan Sturek - Project Manager
• Justin McKendry - Back-End Engineer
• Liam Stienstra - Front-End Engineer
• Samantha Hodge - Lead Testing Engineer

WBS/Gantt

Link is here