bibliofly / biblioflyapp Goto Github PK

BIBLIOFLY
__________

CA-17
CUPERTINO HIGH SCHOOL

CONTENTS
--------
 * Introduction
 * Requirements
 * Installation
 * Software Used
 * Sources
 * Instructions for Running Project
 * Templates
 * Developers

INTRODUCTION
------------
School library systems typically use legacy systems that cause both students and librarians a
hassle. Bibliofly is a modern solution to this problem that makes use of the one thing almost
every student has - a phone. By moving the school's library to the pocket of the user, accessing
the library is easier than ever. As a result, more students will be inclined to read books.

Bibliofly allows students and teachers to checkout books, place holds, and much more all from their
mobile phone. Librarians can view how their library is performing with detailed statistics that
update in real-time. Additionally, an online portal for librarians to add books and users is
available. The source code of this is available here:
https://github.com/bibliofly/Bibliofly-Librarian-Portal.github.io

Bibliofly was built from the ground-up with Android and Java. Custom code paired with open-source
frameworks allowed us to build a well-crafted app that is both aesthetically pleasing and functionally
robust.

REQUIREMENTS
------------
  - An Android phone running Android Lollipop (5.0) or higher
  - Device must have camera capabilities

INSTALLATION
------------
  - App is not available on the Google Play Store
  - Must be run through Android Studio

SOFTWARE USED
-------------
We used Google's Android Studio IDE for developing Android applications. We used Adobe Illustrator
to create our app's icon. Finally, we made use of Github to store our code online, as it provides
an easy way to stay on the same version of code between our members.

SOURCES
-------
We all had prior experience with Android application development before creating this app, so we 
did not need to refer to many tutorials. We referred to Stack Overflow if any questions arose.
Finally, numerous YouTube tutorials helped us gain a better understanding of some of the libraries
we use in Bibliofly.

Open-Source Frameworks
  - Floating Search View (https://github.com/arimorty/floatingsearchview)
  - Sliding Activity (https://github.com/klinker41/android-slidingactivity)
  - ZXing Barcode Scanner (https://github.com/dm77/barcodescanner)
  - MPAndroidChart (https://github.com/PhilJay/MPAndroidChart)

SDKs
  - Firebase Android SDK (https://firebase.google.com/docs/android/setup)

Other Assets
  - Icons were provided by Google's Material Design website (https://material.io/icons)

INSTRUCTIONS FOR RUNNING PROJECT
--------------------------------
To run the Online Library Portal:

https://bibliofly.github.io/Bibliofly-Librarian-Portal.github.io/
Open this link to the Online Library Portal. To log in, use the credentials
	Email:      [email protected]
    Password:   welovebooks

A default CSV file of accounts is provided in the project folder (defaultData.csv).

A few books will be provided that are already in the database, but if you wish to add 
your own books that you will be able to check out, please create a CSV of books 
(barcodes and ISBNs) and follow the instructions on the Online Library Portal.

To run the Bibliofly App:

Attach an Android phone running Android 5.0 or later and open the app in Android Studio. Click the
green "play" button and select the device.

TEMPLATES
---------
No templates were used in the creation of the Bibliofly app. We only used open-source frameworks
to help the functionality of our app.

DEVELOPERS
----------
Anjan Bharadwaj
Tejas Narayanan
Sreehari Ram Mohan