marine-library

byASHUTOSH SINGH

๐Ÿ“˜ PROJECT REQUIREMENT DOCUMENT (PRD) Namma-Pustaka โ€“ Smart Library Assistant for Rural Schools ๐Ÿงพ 1. Project Overview Project Title: Namma-Pustaka Domain: Education Technology (EdTech) Platform: Android Application (Kotlin) Description: Namma-Pustaka is a smart digital library assistant designed for rural schools. It transforms traditional book storage systems into an organized digital platform where students and teachers can easily manage, access, and track books. โ— 2. Problem Statement In many village schools: Libraries are unorganized (books stored in cupboards) No tracking of issued/returned books Students are unaware of available books Teachers manually maintain records โ†’ errors & book loss ๐Ÿ‘‰ This leads to: Poor reading culture Mismanagement of resources Lack of accountability ๐ŸŽฏ 3. Objectives Digitize rural school libraries Encourage reading habits among students Simplify book tracking for teachers Introduce basic digital workflows ๐Ÿ’ก 4. Proposed Solution Namma-Pustaka is a mobile app that: Displays books in a digital catalog Allows students to browse, reserve, and review books Enables teachers to track borrowing digitally Uses QR codes for easy book issuing Sends overdue reminders ๐Ÿ‘ฅ 5. Target Users ๐Ÿ‘จโ€๐ŸŽ“ Students Browse books Reserve books Rate and review ๐Ÿ‘จโ€๐Ÿซ Teachers (Admin) Add/manage books Issue/return books Track overdue books ๐Ÿ” 6. User Roles & Access Feature Student Teacher View Books โœ… โœ… Search Books โœ… โœ… Reserve Books โœ… โŒ Add/Edit Books โŒ โœ… Issue Books (QR) โŒ โœ… View Overdue โŒ โœ… Leaderboard โœ… โœ… ๐Ÿ”„ 7. App Workflow User logs in (Student/Teacher) Dashboard loads Student: Browses catalog โ†’ reserves book โ†’ reviews Teacher: Scans QR โ†’ issues book โ†’ tracks due dates System: Highlights overdue books in RED Updates leaderboard ๐Ÿ“ฑ 8. Features ๐Ÿ“š Book Catalog Grid layout (RecyclerView) Categories: Story, Science, History Search by name/author ๐Ÿ“ท QR Borrow System Scan QR using camera Assign book to student Track issue & return โญ Review System 1โ€“5 star rating One-line feedback ๐Ÿ† Leaderboard Rank students by pages read Monthly tracking ๐Ÿ”” Overdue Alerts Highlight overdue books Reminder notifications ๐Ÿ› ๏ธ 9. Technical Requirements Frontend Language: Kotlin UI: XML (Material Design) Components: RecyclerView, CardView Backend Database: Room DB (local) Optional: Firebase (cloud sync) Libraries QR Scanning: Google ML Kit Image Loading: Glide/Coil ๐Ÿงฑ 10. System Architecture MVVM Architecture Layers: UI Layer (Activity/Fragment) ViewModel Repository Database (Room/Firebase) ๐Ÿ—„๏ธ 11. Data Model Book id title author category pages User id name role (Student/Teacher) Transaction bookId studentId issueDate dueDate status Review rating comment ๐Ÿ“Š 12. Success Criteria Add book using camera input Overdue books show RED color automatically Search functionality works correctly QR-based issue system works Smooth UI navigation ๐ŸŒ 13. Impact ๐Ÿ“– Literacy Promotion Encourages reading habits ๐Ÿงพ Resource Management Reduces book loss ๐Ÿ’ป Digital Awareness Introduces students to digital systems โš ๏ธ 14. Constraints Limited internet in rural areas Low-end Android devices Need for simple UI ๐Ÿš€ 15. Future Enhancements Multi-language support (Kannada + English) Voice-based search AI-based book recommendations Cloud sync across schools โœ… 16. Conclusion Namma-Pustaka is a practical, scalable solution to modernize rural school libraries. It bridges the gap between traditional systems and digital technology, promoting education and efficient resource management. make an app accordint to the contet,have spearte login for librarian and students

HomeSplashLoginProfile
Home

Comments (0)

No comments yet. Be the first!

System Requirements

System Requirement Document
Page 1 of 5

System Requirements Document (SRD)

marine-library

1. Introduction

The "marine-library" project is a smart digital library assistant designed to modernize library management for rural schools. It aims to transform traditional book storage systems into an organized digital platform where students and teachers can efficiently manage, access, and track books. The system will work both online and offline, ensuring usability in areas with limited internet connectivity.

2. System Overview

The marine-library system will be implemented as a mobile application, primarily targeting Android devices. It will provide functionalities for students to browse, reserve, and review books, while enabling teachers to manage book inventories, issue books using QR codes, and track overdue books. Firebase will be used for cloud synchronization, ensuring data consistency across devices.

3. Functional Requirements

Page 2 of 5

As story points:

  • As a Student, I should be able to browse books by categories and search by name or author.
  • As a Student, I should be able to reserve books for borrowing.
  • As a Student, I should be able to rate and review books.
  • As a Student, I should be able to view my reading progress and overdue books.
  • As a Teacher, I should be able to add, edit, and manage books in the catalog.
  • As a Teacher, I should be able to issue and return books using QR codes.
  • As a Teacher, I should be able to track overdue books and send reminders.
  • As a Teacher, I should be able to view a leaderboard of students based on reading activity.
  • As a System, I should highlight overdue books in red and send notifications for reminders.

4. User Personas

1. Student

  • Role: Library user
  • Actions: Browse, reserve, review books, track reading progress, view overdue books.

2. Teacher (Admin)

  • Role: Library manager
  • Actions: Add/edit books, issue/return books, track overdue books, manage student leaderboard.

5. Visuals Colors and Theme

Page 3 of 5

Color Palette

  • primary: #0057D9 (Deep Blue)
  • primary_light: #4DA3FF (Sky Blue)
  • secondary: #FF6F3C (Vibrant Orange)
  • accent: #FFD700 (Golden Yellow)
  • highlight: #FF3B30 (Bright Red)
  • bg: #F9FAFB (Soft White)
  • surface: rgba(255, 255, 255, 0.9) (Translucent White)
  • text: #1A1A1A (Dark Gray)
  • text_muted: #6B7280 (Muted Gray)
  • border: rgba(0, 87, 217, 0.2) (Subtle Blue)

6. Signature Design Concept

Interactive Library Explorer

The homepage will feature an interactive bookshelf where books are displayed as 3D cards. Users can swipe through categories like "Story," "Science," and "History," with smooth transitions powered by framer-motion. Hovering over a book will reveal a quick preview, while clicking will open a detailed view with options to reserve or issue the book.

  • Animations: Books will "pop out" slightly when hovered over, and categories will slide horizontally with inertia-based scrolling.
  • Transitions: Smooth fade-ins for book details and dynamic color shifts for category headers.
  • Libraries Used: framer-motion for animations, react-three/fiber for 3D effects.

7. Interaction Model & Motion Direction

Page 4 of 5

Landing Page Interaction Model

  • Parallax: Layered depth effects for categories and books, with scroll-triggered animations.
  • Animated: Hover transitions for books and smooth page navigation.
  • Internal Pages: Static layouts for dashboards, settings, and forms to prioritize clarity.

Distinctive Section Mechanics

  • Book Categories: Swipeable carousel with inertia scrolling.
  • Leaderboard: Dynamic ranking animations with hover effects on student profiles.
  • Profile Page: Interactive progress bars for reading streaks and overdue books.

8. Non-Functional Requirements

  • Offline functionality for browsing and issuing books.
  • Firebase integration for cloud sync and notifications.
  • Optimized for low-end Android devices.
  • Simple and intuitive UI for rural users.

9. Tech Stack

Frontend

  • Android (Kotlin)
  • XML (Material Design)

Backend

  • Firebase (Cloud Sync)
  • Room DB (Local Database)
Page 5 of 5

Libraries

  • QR Scanning: Google ML Kit
  • Image Loading: Glide/Coil
  • Animations: framer-motion

10. Assumptions and Constraints

  • Limited internet connectivity in rural areas.
  • Low-end Android devices with minimal processing power.
  • Need for a bilingual interface (Kannada + English).

11. Glossary

  • QR Code: A machine-readable code used for book issuing and returning.
  • Leaderboard: A ranking system based on students' reading activity.
  • Firebase: A cloud-based platform for data synchronization and notifications.
  • Room DB: A local database for offline functionality.

This SRD provides a comprehensive blueprint for the marine-library project, ensuring alignment with the user's vision and requirements. Let me know if you'd like to refine or expand any section!