Skip to content

Latest commit

 

History

History
57 lines (40 loc) · 3.46 KB

README.md

File metadata and controls

57 lines (40 loc) · 3.46 KB
Raw

AlphaByte: App for Users

Personal Library Navigator

About

As per the traditional library management system, the students or the end users of the library have to physically approach the library every time and then search for their required book. Hence this task is very tedious for the end users as it might decrease their overall urge to pursue knowledge. Thus this mobile application is an effort to ease their interaction with the library.

10 11

Installation

App Installation:

  1. Clone the entire project repository in htdocs of your xampp server(can use wamp/lamp as well). If you don't have any server installed, install xampp from XAMPP Installers and Downloads for Apache Friends.

  2. The mobile application is developed using flutter. Hence, the Installation of flutter has to be done first.

  3. Perform flutter installation using the given guildlings & steps for your respective operating system.

    • Windows:Windows install - Flutter
    • Linux: Linux install - Flutter
    • MacOS: macOS install - Flutter
    • Chrome OS: Chrome OS install - Flutter

Note:

  • Make sure you properly read & verify the system requirements before moving to installation.
  • If you are a user from China, first read Using Flutter in China - Flutter.
  1. To make sure the installation is proper and to get started with flutter, you can run a hello world application using the guildlines: Write your first Flutter app, part 1 - Flutter (this step is not mandatory)
  2. Now, in the project, goto directory sih2020/app and run the command flutter run in the terminal of your IDE.

*Note:

  • Make sure you turn on your xampp/wamp server and import the database file in MYSQL.
  • Make sure you have an Emulator installed or have your android device connected to the system. If not, install/connect any one using the guidelines.
  1. The app contains various dart files. Hence start navigating from main.dart by simply placing your cursor on the widgets and ctrl+click to get the code file for the followup widget. Through this, you can understand the entire code-flow and widget tree.
  2. Learn more about flutter using their official docs: https://flutter.dev/docs

Usage

This app is specially designed for the end users through which they can

  • Check the books available in the library without being physically present in the library.
  • Reserve a book in advance and get it issued later within the given time frame, by visiting the library.
  • Get important information regarding the book details by simply scanning the QR code through the app.
  • Pay penalty/fine using the UPI feature.
  • Get the library updated timings through the timetable.
  • Connect to other Users and Librarians directly through the Open Chat feature.
  • Read and download the E-Books provided by the library.
  • Get notified via emails for every transaction with the library.
  • Check out the leaderboard and increase the overall urge to read more.

For detailed directions and help on how to use the website, refer APP USAGE document.