nthnn / librarium

Library semi-automated management system for borrowing and returning books with Electron and Arduino platform.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

librarium

Librarium is a semi-automated library book borrowing and returning system built using Electron and pure JavaScript. It provides a user-friendly interface for managing library resources, including adding books and users, generating printable QR codes for books and students, and recording transactions.

Features

  • Book Management: Easily add, edit, and remove books from the library database.
  • User Management: Add and manage users, such as students or library members.
  • QR Code Generation: Generate printable QR codes for books and users, making it easy to track borrowing and returning.
  • Automated Scanning: Utilizes an Arduino ultrasonic sensor and webcam to automatically scan QR codes when books are borrowed or returned.
  • Manual Transaction Recording: Users can manually record transactions if needed, providing flexibility in the borrowing and returning process.

Getting Started

To get started with Librarium, follow these steps:

  1. Clone the Librarium repository to your local machine using the following command:
git clone https://github.com/nthnn/librarium.git --depth 1
  1. Navigate to the project directory and install the necessary dependencies using npm:
cd librarium && npm install && cd librarium-app && npm install && cd ..
  1. Start the application by running the following command:
npm run start

Alternatively, the command below can build the librarium as a Desktop app:

npm run pack-up
  1. Follow the Arduino schematics (as shown below) and then upload the librarium-firmware to your Arduino UNO or any board of your choice. Then, ensure that your Arduino ultrasonic sensor and webcam are connected to your computer and properly configured.

Librarium Schematic Diagram

  1. Once the application is running, you can start managing your library resources, adding books, users, and recording transactions. Also, note that users must scan the book's QR code first before the student's QR code.

Note

The default username and password is "admin".

Screenshots

Screenshot 1

Librarium Start-up Splashscreen


Screenshot 2

Administrator Log-in Page


Screenshot 3

Dashboard Admin View


Screenshot 4

Book Management Section


Screenshot 5

User Management Section


Screenshot 6

Web Camera Selection Panel

License

Copyright 2024 - Nathanne Isip

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

Library semi-automated management system for borrowing and returning books with Electron and Arduino platform.


Languages

Language:JavaScript 93.6%Language:C++ 6.4%