university-library
A University Library Management System with Admin Panel
📋 Table of Contents
- 🤖 Introduction
- ⚙️ Tech Stack
- 🔋 Features
- 🤸 Quick Start
- 🧪 Development Roadmap
- 🔗 Assets
- 🚀 More
🤖 Introduction
Built with Next.js, TypeScript, and PostgreSQL, the University Library Management System is a production-grade platform featuring a public-facing app and an admin interface. It offers advanced functionalities like seamless book borrowing with reminders and receipts, robust user management, automated workflows, and a modern, optimized tech stack for real-world scalability.
⚙️ Tech Stack
- Frontend & Backend: Next.js 14 with App Router
- Language: TypeScript
- Database: PostgreSQL with Drizzle ORM
- Styling: Tailwind CSS with ShadCN UI components
- Authentication: NextAuth.js
- Media Processing: ImageKit
- Email Service: EmailJS (replacing Resend)
- Form Handling: React Hook Form with Zod validation
🔋 Features
User Features
👉 Authentication System: Personalized onboarding flow with email notifications
👉 Home Page: Highlighted books and newly added books with 3D effects
👉 Library Page: Advanced filtering, search, and pagination for book discovery
👉 Book Detail Pages: Availability tracking, book summaries, videos, and similar book suggestions
👉 Profile Page: Account management, borrowed books tracking, and receipt downloads
👉 Borrowing System: Seamless book borrowing with automated reminders and receipts
Admin Features
👉 Analytics Dashboard: Statistics on users, books, and borrowing activity
👉 User Management: View and manage users, approve/revoke access, and change roles
👉 Book Management: Add, edit, and manage library books with advanced search
👉 Borrowing Records: Track and manage all book borrowing activity
👉 Account Approval: Review and approve new user registrations
Technical Features
👉 Responsive Design: Mobile-first approach with full responsiveness across devices
👉 Type Safety: Comprehensive TypeScript typing throughout the application
👉 Error Handling: Consistent error handling with error boundaries and fallbacks
👉 Performance Optimization: Efficient data fetching and rendering strategies
👉 Security: Authentication, authorization, and data validation
🤸 Quick Start
Follow these steps to set up the project locally on your machine.
Prerequisites
Make sure you have the following installed on your machine:
Cloning the Repository
git clone https://github.com/momed-ali01/university-library.git
cd university-library
Installation
Install the project dependencies using npm:
npm install --legacy-peer-deps
Set Up Environment Variables
Create a new file named .env.local in the root of your project and add the following content:
# Database
DATABASE_URL=
# Auth
AUTH_SECRET=
# ImageKit
NEXT_PUBLIC_IMAGEKIT_PUBLIC_KEY=
IMAGEKIT_PRIVATE_KEY=
NEXT_PUBLIC_IMAGEKIT_URL_ENDPOINT=
# API Endpoints
NEXT_PUBLIC_API_ENDPOINT=
NEXT_PUBLIC_PROD_API_ENDPOINT=
# Email Service (EmailJS)
EMAILJS_SERVICE_ID=
EMAILJS_TEMPLATE_ID=
EMAILJS_PUBLIC_KEY=
Database Setup
Set up your PostgreSQL database and run the migrations:
npm run db:generate
npm run db:migrate
Running the Project
npm run dev
Open http://localhost:3000 in your browser to view the project.
🧪 Development Roadmap
Our development roadmap is organized by priority areas:
In Progress
- Replacing Resend with EmailJS for email notifications
- Improving application interfaces
- Removing Upstash dependencies
Upcoming Improvements
- Code Quality: Input validation, JSDoc comments, consistent naming conventions
- Performance: Server-side pagination, image optimization, caching strategies
- Security: CSRF protection, rate limiting, authorization checks
- Accessibility: ARIA attributes, keyboard navigation, screen reader support
- User Experience: Toast notifications, loading indicators, form validation feedback
- Architecture: Component refactoring, state management implementation
- DevOps: CI/CD pipeline, automated testing, monitoring
For a detailed list of tasks, see our tasks.md file.
🔗 Assets
- Assets used in the project can be found here
- Watch how to Integrate EmailJS in Your Website.
- Source Code for Integrating EmailJS in any of your codebases.