Skip to content

lilynex/libris-flow

Repository files navigation

📚 LibrisFlow

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

MIT License Next.js Appwrite TypeScript


✨ Features

  • 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

🛠 Tech Stack

Layer Technology
Frontend Next.js 15, TypeScript, Tailwind CSS, shadcn/ui
State Zustand, TanStack Query
Forms React Hook Form, Zod
Backend Appwrite (Auth, Database, Storage, Realtime)
Build Turborepo, pnpm
Deploy Docker, Vercel

🚀 Quick Start

# 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

Visit http://localhost:3000

📖 Documentation

🏗 Architecture

libris-flow/
├── apps/
│   └── web/                 # Next.js 15 App Router
│       ├── src/
│       │   ├── app/         # Routes (App Router)
│       │   ├── components/  # UI & shared components
│       │   ├── hooks/       # Custom React hooks
│       │   ├── lib/         # Utilities & Appwrite client
│       │   ├── services/    # Data access layer
│       │   ├── store/       # Zustand stores
│       │   ├── types/       # TypeScript types
│       │   └── validations/ # Zod schemas
│       └── public/
├── packages/
│   ├── shared-types/        # Shared models & constants
│   └── configs/             # Shared TS/ESLint configs
├── scripts/                 # Database setup scripts
├── docker/                  # Docker deployment
└── docs/                    # Documentation

👥 User Roles

Role Capabilities
Super Admin Full system access, analytics, settings, user management
Librarian Book management, issue/return, student management
Student Browse books, view issues, check fines

🐳 Docker Deployment

cd docker
docker-compose up -d

🗺 Roadmap

  • Phase 1: Architecture, Auth, Dashboards, Database Schema
  • Phase 2: Book Management, Issue/Return Flow, Analytics
  • Phase 3: Notifications, Barcode Support, Advanced Search, Reports
  • Phase 4: Mobile App, API Documentation, Plugins

🤝 Contributing

Contributions are welcome! Please read our Contributing Guide first.

📄 License

MIT © LilyNex

About

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

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages