Libris Flow

Abstract

1. Introduction

Modern, open-source library management system for schools, colleges, and institutes.

2. Objective

Modern, open-source library management system for schools, colleges, and institutes.

This project demonstrates how TypeScript can be applied to a real-world Full Stack Web Development problem.

3. Key Features / Modules

• Role-Based Access — Super Admin, Librarian, and Student dashboards
• Book Management — Full catalog with copies, barcodes, and rack locations
• Issue & Return — Quick issue/return flow with due date tracking
• Fine Management — Automatic overdue detection and fine calculation
• Real-time Search — Search books by title, author, ISBN, or category
• Dark Mode — Full dark/light theme support
• Mobile Responsive — Works on all screen sizes
• Self-Hostable — Deploy anywhere with Docker

4. Technology Stack

5. System Requirements

General requirements for this technology stack — check the README for exact versions.

• Node.js (LTS) and npm / yarn / pnpm
• VS Code or any code editor
• Git (to clone the repository)

6. Installation & Setup

git clone https://github.com/lilynex/libris-flow.git
cd libris-flow

# Clone
git clone https://github.com/lilynex/libris-flow.git
cd libris-flow

# Install
pnpm install

# Configure
cp .env.example apps/web/.env.local
# Edit apps/web/.env.local with your Appwrite credentials

# Setup database
npx tsx scripts/setup-appwrite.ts

# Run
pnpm dev

cd docker
docker-compose up -d

Full setup instructions are in the project README.

7. Future Enhancements

Suggested extensions you can add to make this your own project.

• Add role-based access control
• Deploy on a VPS or cPanel hosting with a custom domain
• Add automated tests and a CI pipeline

8. Viva / Review Questions

Common questions examiners ask for projects in this domain.

1. Explain the frontend, backend and database layers of this application.
2. How is user authentication and authorisation implemented?
3. Describe the main database tables / collections and their relationships.
4. Which REST APIs or routes are exposed and what do they return?
5. How would you deploy this application to production?

9. Source Code & License

This project is developed by lilynex and published on GitHub under the MIT License. Please follow the license terms and credit the original author when you use or modify this code.