Skip to content

Commit

Permalink
added the docs for demo
Browse files Browse the repository at this point in the history
  • Loading branch information
vijayan108 committed Aug 20, 2024
1 parent 0d470c4 commit bf81704
Show file tree
Hide file tree
Showing 13 changed files with 320 additions and 212 deletions.
85 changes: 81 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,84 @@
## Library Management
## BookHaven Library Management System

This is Library Managemnet App
### Overview

#### License
Welcome to **BookHaven**, a Frappe framework-based solution designed for efficient management of books and patrons in libraries. Our system ensures streamlined operations, allowing you to focus on enhancing the library experience.

mit
### Features

- **Catalog Management:** Seamlessly add, edit, and delete books with ease.

- **Patron Information:** Efficiently manage borrower details and track borrowing history.

- **Book Viewing:** Easily view available books in the library.

- **Import Books:** Import large volumes of book data quickly and efficiently.

- **Issue Books:** Issue books to patrons, with checks on outstanding amounts.

- **Return Books:** Return books while automatically calculating and applying charges for late returns.

- **Membership Management:** Add and manage library members, ensuring up-to-date records.

### Installation

Ensure the Frappe framework is installed. Refer to the [Frappe Installation Guide](https://frappeframework.com/docs/user/en/installation). Make sure you are in the `frappe-bench` directory.

### Installation Steps:

1. **Install the App:**
```bash
bench get-app https://github.com/vijayan108/Library-Management.git
```

2. **Create a New Site:**

```bash

bench new-site [library-management-app]

```
3. **Install the App in the Site:**

```bash

bench --site [library-management-app] install-app library_management_system
```

4.**Start the App:**

```bash

bench start
Access the app at http://localhost:8000.
```
### Usage

Visit this site to view the books and availability: [https://frappe.selfmade.one/](https://frappe.selfmade.one/)


![Site](docs/book1.png)

#### View the Books

![view the books](docs/book2.png)

#### Import the Books

![import the books](docs/book5.png)

#### Issue Books Based on the Outstanding Amount

![issue the books](docs/book3.png)

#### Return the Book with Charge Amount

![return the books](docs/book4.png)

#### Add the Library Member

![add the member](docs/book6.png)


### License
This project is under the MIT License. Your contributions are valued as we refine the BookHaven Library Management System.
Binary file added docs/book1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/book2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/book3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/book4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/book5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/book6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,9 @@
{%- endif -%}
</div>
</div>

<script>
document.querySelectorAll('.page-breadcrumbs').forEach(element => {
element.remove();
});

</script>
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
"allow_print": 0,
"anonymous": 0,
"apply_document_permissions": 0,
"banner_image": "https://i.ibb.co/9WGqhyh/back-school-concept-with-woman-studying-library-23-2148172403.jpg",
"button_label": "Add Member",
"condition_json": "[]",
"creation": "2024-08-15 01:49:59.036985",
Expand All @@ -18,7 +19,7 @@
"list_columns": [],
"login_required": 0,
"max_attachment_size": 0,
"modified": "2024-08-15 02:22:58.951420",
"modified": "2024-08-20 18:44:17.500836",
"modified_by": "Administrator",
"module": "Library Management",
"name": "add-member",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"allow_print": 0,
"anonymous": 0,
"apply_document_permissions": 0,
"banner_image": "/files/Screenshot (72).png",
"banner_image": "https://img1.etsystatic.com/197/0/14200326/il_fullxfull.1267148033_pa5j.jpg",
"button_label": "Submit",
"condition_json": "[]",
"creation": "2024-08-14 11:56:20.807075",
Expand All @@ -19,8 +19,8 @@
"is_standard": 1,
"list_columns": [],
"login_required": 0,
"max_attachment_size": 0,
"modified": "2024-08-17 02:37:32.612504",
"max_attachment_size": 10,
"modified": "2024-08-20 18:29:17.734231",
"modified_by": "Administrator",
"module": "Library Management",
"name": "article-upload",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@
"allow_print": 0,
"anonymous": 0,
"apply_document_permissions": 0,
"button_label": "Buy Now",
"banner_image": "https://i.ibb.co/Sw1NCWG/cafe-frankfurt-germany-1268-20912.jpg",
"button_label": "Save Now",
"condition_json": "[]",
"creation": "2024-08-17 02:10:47.207987",
"doc_type": "Library Transaction",
Expand All @@ -18,7 +19,7 @@
"list_columns": [],
"login_required": 0,
"max_attachment_size": 0,
"modified": "2024-08-17 02:12:27.809597",
"modified": "2024-08-20 18:46:22.364152",
"modified_by": "Administrator",
"module": "Library Management",
"name": "library-transaction",
Expand Down
Loading

0 comments on commit bf81704

Please sign in to comment.