sannlynnhtun-coding commited on
Commit
f81f07d
Β·
1 Parent(s): 068485b

docs: update README.md to provide comprehensive project overview, key features, technology stack, project structure, and getting started instructions for the Library Management System

Browse files
Files changed (1) hide show
  1. README.md +40 -1
README.md CHANGED
@@ -1 +1,40 @@
1
- # LibraryManagement
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Library Management System
2
+
3
+ A comprehensive Library Management System built with a decoupled architecture featuring an ASP.NET Core Web API backend and an ASP.NET Core MVC frontend.
4
+
5
+ ## πŸš€ Project Overview
6
+
7
+ This system is designed to streamline library operations, from managing book catalogs to tracking member borrowings and handling subscriptions. It provides a secure, role-based environment for both administrators and library members.
8
+
9
+ ### Key Features
10
+
11
+ - **πŸ“š Catalog Management**: Full CRUD operations for books and categories, including cover image support.
12
+ - **πŸ‘₯ Member Management**: Administrative tools to manage library members, their profiles, and roles.
13
+ - **πŸ”– Borrowing System**: Comprehensive tracking of book loans, returns, and history.
14
+ - **πŸ’³ Subscription Plans**: Tiered membership system where administrators can assign and manage subscription plans.
15
+ - **πŸ” Secure Access**: Role-based access control (RBAC) powered by ASP.NET Core Authentication, ensuring only authorized users can perform sensitive actions.
16
+
17
+ ## πŸ› οΈ Technology Stack
18
+
19
+ ### Backend
20
+ - **Framework**: ASP.NET Core 8.0 Web API
21
+ - **ORM**: Entity Framework Core
22
+ - **Database**: SQL Server
23
+ - **Architecture**: Feature-based directory structure for better maintainability.
24
+
25
+ ### Frontend
26
+ - **Framework**: ASP.NET Core MVC
27
+ - **Styling**: Modern CSS with a focus on premium user experience.
28
+ - **Authentication**: Cookie-based authentication for seamless session management.
29
+
30
+ ## πŸ“ Project Structure
31
+
32
+ - **`/Backend`**: The RESTful API service handling business logic and data persistence.
33
+ - **`/Frontend`**: The MVC web application providing the user interface.
34
+ - **`/Database`**: Contains SQL scripts for database initialization and schema definitions.
35
+
36
+ ## 🚦 Getting Started
37
+
38
+ 1. **Database Setup**: Run the scripts in `/Database` to initialize your SQL Server instance.
39
+ 2. **Run Backend**: Start the `Backend` project to host the API.
40
+ 3. **Run Frontend**: Start the `Frontend` project to access the management dashboard.