Skip to content

Commit

Permalink
1.10.100
Browse files Browse the repository at this point in the history
  • Loading branch information
bugfish\bugfishtm committed Mar 1, 2025
1 parent 9345ab4 commit 12ff42b
Show file tree
Hide file tree
Showing 9 changed files with 102 additions and 56 deletions.
14 changes: 7 additions & 7 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
## Code of Conduct
## Code of Conduct

### Our Pledge
### 🤝 Our Pledge

We're building cool stuff for free to push technology forward. If you're here, you're part of that mission. Let's work together, share ideas, and make awesome things happen!
We're building cool stuff for free to push technology forward. If you're here, you're part of that mission. Let's work together, share ideas, and make awesome things happen!

### Our Standards
### 📏 Our Standards

* **Positive:** Be kind, empathetic, and respectful. Give constructive feedback.
* **Unacceptable:** Harassment, offensive comments, personal attacks, sharing private info without consent.
* **Positive:** Be kind, empathetic, and respectful. Give constructive feedback.
* **🚫 Unacceptable:** Harassment, offensive comments, personal attacks, sharing private info without consent.

🐟 Bugfish <3
🐟 Bugfish <3
19 changes: 15 additions & 4 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,36 @@

Hey there! Thanks for considering contributing to this project! We appreciate your interest and are excited to have you join our community of contributors.

## How You Can Help
## 🚀 How You Can Help

* **Report Bugs:** Found something that's not working as expected? Let us know! Clear and detailed bug reports are incredibly valuable.
* **Suggest Features:** Got a brilliant idea for a new feature or improvement? We'd love to hear it!
* **Submit Code:** Ready to roll up your sleeves and write some code? Awesome! Check out our coding style guidelines (see below) and dive in.
* **Improve Documentation:** Documentation is just as important as code. Help us make it clear, concise, and easy to understand.
* **Spread the Word:** Tell your friends, write blog posts, share on social media – help us get the word out!

## Coding Style Guidelines
## 📢 Spread the Word

Help us grow by sharing this project with others! You can:

* **Tweet about it** – Share your thoughts on [Twitter/X](https://twitter.com) and tag us!
* **Post on LinkedIn** – Let your professional network know about this project on [LinkedIn](https://www.linkedin.com).
* **Upvote on Product Hunt** – If we're listed, give us a boost on [Product Hunt](https://www.producthunt.com)!
* **Share on Reddit** – Talk about it in relevant subreddits like [r/programming](https://www.reddit.com/r/programming/) or [r/opensource](https://www.reddit.com/r/opensource/).
* **Write a Blog Post** – A tutorial, review, or use-case would be awesome!
* **Tell Your Community** – Spread the word in Discord servers, Slack groups, and forums.

## 🎨 Coding Style Guidelines

* Follow the existing coding style.
* Write clear, concise, and well-commented code.
* Keep your pull requests focused on a single issue or feature.

## Code of Conduct
## ⚖️ Code of Conduct

Please note that this project has a Code of Conduct (.github/CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.

## Need Help?
## Need Help?

If you're having trouble getting started or have any questions, feel free to reach out to us! You can:

Expand Down
12 changes: 6 additions & 6 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,24 @@ assignees: ''

---

**Describe the bug**
## Describe the bug
A clear and concise description of what the bug is.

**To Reproduce**
## To Reproduce
Steps to reproduce the behavior:
1. Go to '...'
2. Do '....'
3. See error

**Expected behavior**
## Expected behavior
A clear and concise description of what you expected to happen.

**Screenshots**
## Screenshots
If applicable, add screenshots to help explain your problem.

**Environment:**
## Environment:
- OS: [e.g. Windows, macOS, Linux]
- Version [e.g. Software Version, Browser Version]

**Additional context**
## Additional context
Add any other context about the problem here.
9 changes: 3 additions & 6 deletions .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,11 @@ assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. "I'm always frustrated when..."

**Describe the solution you'd like**
## Describe the solution you'd like
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
## Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
## Additional context
Add any other context or screenshots about the feature request here.
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/QUESTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Question
about: Ask a question about the project.
title: "[QUESTION] Short description of your question"
labels: question
assignees: ''
---

## Question
A clear and concise question about the project.

## Context
Provide any relevant details, such as what you're trying to achieve, any challenges you're facing, or related documentation/code references.

## What Have You Tried?
List any steps you've taken to find an answer, such as searching the documentation, checking previous issues, or testing solutions.

## 🖼Additional Information
If applicable, include screenshots, code snippets, or links that might help clarify your question.

## Environment
- OS: [e.g., Windows, macOS, Linux]
- Version: [e.g., Software Version, Browser Version]

1 change: 0 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
- [ ] I have tested these changes locally
- [ ] I have updated the documentation accordingly
- [ ] My code follows the project's coding standards
- [ ] I have added/updated tests for this change

## Screenshots (if applicable)
[Add screenshots here to demonstrate visual changes]
19 changes: 15 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,36 @@

Hey there! Thanks for considering contributing to this project! We appreciate your interest and are excited to have you join our community of contributors.

## How You Can Help
## 🚀 How You Can Help

* **Report Bugs:** Found something that's not working as expected? Let us know! Clear and detailed bug reports are incredibly valuable.
* **Suggest Features:** Got a brilliant idea for a new feature or improvement? We'd love to hear it!
* **Submit Code:** Ready to roll up your sleeves and write some code? Awesome! Check out our coding style guidelines (see below) and dive in.
* **Improve Documentation:** Documentation is just as important as code. Help us make it clear, concise, and easy to understand.
* **Spread the Word:** Tell your friends, write blog posts, share on social media – help us get the word out!

## Coding Style Guidelines
## 📢 Spread the Word

Help us grow by sharing this project with others! You can:

* **Tweet about it** – Share your thoughts on [Twitter/X](https://twitter.com) and tag us!
* **Post on LinkedIn** – Let your professional network know about this project on [LinkedIn](https://www.linkedin.com).
* **Upvote on Product Hunt** – If we're listed, give us a boost on [Product Hunt](https://www.producthunt.com)!
* **Share on Reddit** – Talk about it in relevant subreddits like [r/programming](https://www.reddit.com/r/programming/) or [r/opensource](https://www.reddit.com/r/opensource/).
* **Write a Blog Post** – A tutorial, review, or use-case would be awesome!
* **Tell Your Community** – Spread the word in Discord servers, Slack groups, and forums.

## 🎨 Coding Style Guidelines

* Follow the existing coding style.
* Write clear, concise, and well-commented code.
* Keep your pull requests focused on a single issue or feature.

## Code of Conduct
## ⚖️ Code of Conduct

Please note that this project has a Code of Conduct (.github/CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.

## Need Help?
## Need Help?

If you're having trouble getting started or have any questions, feel free to reach out to us! You can:

Expand Down
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Online-Book-Renting (OBR)


## Introduction
## 📖 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.

Expand All @@ -15,43 +15,43 @@ Relevant Repository Folders for this Project:
|_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
## 🌟 Features

### Book Rental Management
### 📚 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
### 👥 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
### 🔗 ISBN API Connections

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

## Documentation
## 📜 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
## ⚙️ 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
## 🌍 Multi-Language Support

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

Expand All @@ -68,14 +68,14 @@ This project supports multiple language, you can add languages by your own or ch
![Language Flag](./_images/_language/kr.png)
![Language Flag](./_images/_language/tr.png)

## How to get Support?
## 🤝 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.
- [Bugfish Forum](www.bugfish.eu/forum)
- [Mail Support](mailto:request@bugfish.eu)
- [Github Issues](https://github.com/bugfishtm/Online-Book-Renting/issues)

## Information for Developers
## 👨‍💻 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.

Expand All @@ -89,7 +89,7 @@ Framework Documentation:
https://bugfishtm.github.io/bugfish-framework/


## Powered by Suitefish
## 💻 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.

Expand All @@ -98,12 +98,12 @@ This project has been created with SuitefishCMS and is available to you for free
![Bugfish Framework](./_images/_banner/bugfish-framework-banner.jpg)


## Licensing Information
## 📜 Licensing Information

### CMS System
### 🏛️ 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
### 🛠️ 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.

Expand Down
32 changes: 18 additions & 14 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,24 @@
## Security Policy
## Security Policy

### Reporting a Vulnerability
### 🛡️ Reporting a Vulnerability

We take the security of our project seriously. If you discover a security vulnerability, please follow these steps:
We take the security of our project seriously. If you discover a security vulnerability, please follow these steps:

1. **Do not** create a public GitHub issue for the vulnerability.
2. Email your findings to security@bugfish.eu
3. Provide as much information as possible, including:
- A description of the vulnerability
- Steps to reproduce
- Potential impact
1. **Do not** create a public GitHub issue for the vulnerability.
2. Email your findings to security@bugfish.eu
3. Provide as much information as possible, including:
- A description of the vulnerability
- Steps to reproduce
- Potential impact

### What to Expect
### 🔍 What to Expect

- We will acknowledge receipt of your report.
- We will strive to keep you informed about the progress of addressing the issue.
- Once the vulnerability is confirmed and fixed, we will inform you.
- We will acknowledge receipt of your report.
- We will strive to keep you informed about the progress of addressing the issue.
- Once the vulnerability is confirmed and fixed, we will inform you.

🐟 Bugfish <3
### ⚖️ No Warranty

This project is licensed under **GPLv3**, which means it comes **without any warranty**. We provide the software **as-is**, without guarantees of security, reliability, or fitness for any purpose. Use at your own risk.

🐟 Bugfish <3

0 comments on commit 12ff42b

Please sign in to comment.