https://github.com/menoc61/library-management
https://github.com/menoc61/library-management
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/menoc61/library-management
- Owner: menoc61
- Created: 2025-01-20T23:57:58.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2025-01-21T02:51:05.000Z (4 months ago)
- Last Synced: 2025-01-28T21:40:03.457Z (4 months ago)
- Language: TypeScript
- Homepage: https://menoc61-bookwise.vercel.app
- Size: 1.92 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
A University Library Management System with Admin Panel
## 📋 Table of Contents
1. 🤖 [Introduction](#introduction)
2. ⚙️ [Tech Stack](#tech-stack)
3. 🔋 [Features](#features)
4. 🤸 [Quick Start](#quick-start)
Built with Next.js, TypeScript, and Postgres, 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.
- Next.js
- PostgreSQL
- Upstash
- ImageKit
- TypeScript
- Resend
- Tailwind CSS
## 🔋 Features
### Features of the University Library Management System Project
👉 **Open-source Authentication**: 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 suggestions for similar books.
👉 **Profile Page**: Manage accounts, track borrowed books, and download receipts.
👉 **Onboarding Workflows**: Automated welcome emails when users sign up, with follow-ups based on inactivity or activity dates.
👉 **Borrow Book Reminder**: Customized email notifications sent before, on, and after the due date, reminding users to return books or avoid charges.
👉 **Borrow Book Receipt**: Automatically generates a customized PDF receipt when a book is successfully borrowed.
👉 **Analytics Dashboard**: Statistics, new users, books, borrow requests, and more.
👉 **All Users Page**: View and manage users, including approving or revoking access.
👉 **Account Requests Page**: Admin approval for account requests, with email notifications for user verification.
👉 **All Books Page**: List and manage all library books with advanced search, pagination, and filters.
👉 **Book Management Forms**: Add new books and edit existing entries.
👉 **Book Details Page**: Detailed book information for administrators.
👉 **Borrow Records Page**: Complete borrow history with pagination and search.
👉 **Role Management**: Change user roles to invite more admins, with email notifications sent upon role updates.
👉 **Advanced Functionalities**: Caching, rate-limiting, DDoS protection, and custom notifications.
👉 **Database Management**: Postgres with Neon for scalable and collaborative database handling.
👉 **Real-time Media Processing**: ImageKit for image and video optimization and transformations.
👉 **Efficient Caching**: Upstash Redis for caching, workflows, and triggers.
👉 **Database ORM**: Drizzle ORM for simplified and efficient database interactions.
👉 **Modern UI/UX**: Built with TailwindCSS, ShadCN, and other cutting-edge tools.
👉 **Technology Stack**: Next.js with TypeScript for scalable development, and NextAuth for robust authentication.
👉 **Seamless Email Handling**: Resend for automated email communications, including notifications and updates.
and many more, including code architecture and reusability
Follow these steps to set up the project locally on your machine.
**Prerequisites**
Make sure you have the following installed on your machine:
- [Git](https://git-scm.com/)
- [Node.js](https://nodejs.org/en)
- [npm](https://www.npmjs.com/) (Node Package Manager)
**Cloning the Repository**
```bash
git clone https://github.com/menoc61/library-management.git
cd library-management
```
**Installation**
Install the project dependencies using npm:
```bash
npm install
```
**Set Up Environment Variables**
Create a new file named `.env` in the root of your project and add the following content:
```env
NEXT_PUBLIC_IMAGEKIT_PUBLIC_KEY=
IMAGEKIT_PRIVATE_KEY=
NEXT_PUBLIC_IMAGEKIT_URL_ENDPOINT=
NEXT_PUBLIC_API_ENDPOINT=
NEXT_PUBLIC_PROD_API_ENDPOINT=
DATABASE_URL=
UPSTASH_REDIS_URL=
UPSTASH_REDIS_TOKEN=
AUTH_SECRET=
# Required for workflow
QSTASH_URL=
QSTASH_TOKEN=
# RESEND_TOKEN=
RESEND_TOKEN=
```
Replace the placeholder values with your actual ImageKit, NeonDB, Upstash, and Resend credentials. You can obtain these credentials by signing up on the [ImageKit](https://imagekit.io/), [NeonDB](https://fyi.neon.tech/), [Upstash](https://upstash.com/), and [Resend](https://resend.com/).
use the following command to run the project locally:
**Running the Project**
```bash
npm run dev
```
Open [http://localhost:3000](http://localhost:3000) in your browser to view the project.