Skip to content

Files

Latest commit

author
bugfish\bugfishtm
Mar 1, 2025
12ff42b · Mar 1, 2025

History

History
110 lines (70 loc) · 4.29 KB

README.md

File metadata and controls

110 lines (70 loc) · 4.29 KB

Online-Book-Renting (OBR)

📖 Introduction

The Online-Book-Renting (obr) system allows you to manage books, display them on a public page, and enable users to rent or donate books.

Screenshot

Relevant Repository Folders for this Project:

File/Folder Description
_docker We use this folder to build our docker images.
_source Containts the product, upload content of this folder to your webservers public html directory.
docs Execute index.html in your browser to get access to the full documentation.

🌟 Features

📚 Book Rental Management

Feature Description
Book Rental Rent books to users and set return deadlines.
Deadline Tracking Monitor if users exceed return deadlines and manage necessary actions.
Additional Information Add notes and user deposits for book security.

👥 User and Permission Management

Role Permissions
Administrator Users Access and manage all admin-related sections of the library.
Default Users Request and donate books, view available books.
Guests View the entire collection of books without logging in.

🔗 ISBN API Connections

Feature Description
ISBN API Enable API connections to automatically retrieve and pre-fill book details.

📜 Documentation

You can also find the documentation in this repositories "docs" folder. Just execute the index.html file in your browser and you will have access to the documentation and all included information.

Documentation: https://bugfishtm.github.io/Online-Book-Renting/

⚙️ Installation

To get information about the installation process on your server, visit our documentation which is linked in the "Documentation" section of this readme. You can also view our documentation directly with your brower, which you can find in the "docs" folder of this repository

Installation Instructions: https://bugfishtm.github.io/Online-Book-Renting/installation.html

🌍 Multi-Language Support

This project supports multiple language, you can add languages by your own or change text on the website by overriding translations.

Language Flag Language Flag Language Flag Language Flag Language Flag Language Flag Language Flag Language Flag Language Flag Language Flag Language Flag Language Flag

🤝 How to get Support?

Should you encounter any issues or have questions while using this software, please do not hesitate to reach out to us.

👨‍💻 Information for Developers

As this project is based on Suitefish CMS, you should take a look at the official CMS Documentation if you plan to develop your own modules or modify existing modules.

Product Documentation:
https://bugfishtm.github.io/Online-Book-Renting/

CMS Documentation:
https://bugfishtm.github.io/suitefish-cms/

Framework Documentation:
https://bugfishtm.github.io/bugfish-framework/

💻 Powered by Suitefish

This project has been created with SuitefishCMS and is available to you for free. The Backend consists of a various set of Suitefish functionalities and the full included Bugfish-Framework.

Bugfish Framework

Bugfish Framework

📜 Licensing Information

🏛️ CMS System

The Suitefish CMS is listed as GPLv3 Licensed project. Please see license.md file for more information about this projects license.

🛠️ 3rd Party Libraries

View _licenses folder to see which 3rd party scripts have been used and which external templates and functionalities have been implemented. Take care to respect every single license.

🐟 Bugfish <3