https://github.com/bugfishtm/bugfish-dolibarr-module
📦 Dolibarr ➡️ A module to include "Bugfish Framework" into Dolibarr and additional logging and debugging features.
https://github.com/bugfishtm/bugfish-dolibarr-module
bugfish bugfish-framework bugfishtm dolibarr dolibarr-erp extension gplv3 gplv3-licensing logging-framework modules php-framework
Last synced: about 2 months ago
JSON representation
📦 Dolibarr ➡️ A module to include "Bugfish Framework" into Dolibarr and additional logging and debugging features.
- Host: GitHub
- URL: https://github.com/bugfishtm/bugfish-dolibarr-module
- Owner: bugfishtm
- License: gpl-3.0
- Created: 2023-09-24T17:54:13.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-08T02:10:33.000Z (about 2 months ago)
- Last Synced: 2025-04-13T03:17:02.618Z (about 2 months ago)
- Topics: bugfish, bugfish-framework, bugfishtm, dolibarr, dolibarr-erp, extension, gplv3, gplv3-licensing, logging-framework, modules, php-framework
- Language: PHP
- Homepage: https://bugfishtm.github.io/Bugfish-Dolibarr-Module/
- Size: 17.8 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Support: docs/support.html
Awesome Lists containing this project
README
# Bugfish Dolibarr Module [934285]
## 🔍 Overview
The Bugfish Dolibarr Module integrates the Bugfish Framework into Dolibarr, offering advanced features for development and debugging.
### Key Features
- **Trigger and Object Logging:** View detailed trigger and object information under Utilities in the xFramework menu.
- **JavaScript Error Logging:** Track and access JavaScript errors caused by users under Utilities -> xFramework -> JavaScript Logging.
- **MySQL Error Logging:** Access logs for MySQL errors related to x_class_mysql under Utilities in the xFramework menu.
- **Changelog:** Monitor changes in various areas (e.g., facture, bank_account, user) under Utilities -> xFramework -> Process Logs.
### Bugfish Framework Integration
The module includes Bugfish Framework v.3.20, which may not be the latest version. Instructions for updating the framework can be found in this readme file.
### Extension Functions
All extension functions from the `m_library.php` file in the Dolibarr functions module are included. For detailed information, refer to the documentation linked above.
### Updating the Bugfish Framework
To update the Bugfish Framework to a newer version:
1. Download the latest version from [Bugfish Framework GitHub](https://github.com/bugfishtm/bugfish-framework).
2. Move files from the "_framework" folder to the `xframework/remote` folder, overwriting existing files.
3. Update files directly on your server or create a new zip file and push it to the repository.
## 🛠️ Installation
For installation instructions, please refer to our documentation, which can be found in the "Documentation" section of this README. You can access the instructions online at [https://bugfishtm.github.io/Bugfish-Dolibarr-Module/installation.html](https://bugfishtm.github.io/Bugfish-Dolibarr-Module/installation.html) or locally at [./docs/installation.html](./docs/installation.html).
## 📖 Documentation
The following documentation is intended for both end-users and developers.
| **Description** | **Link** |
|----------------------------------------------------------------------|-------------------------------------------------------------------------------------------------|
| Access the online documentation for this project. | [https://bugfishtm.github.io/Bugfish-Dolibarr-Module/index.html](https://bugfishtm.github.io/Bugfish-Dolibarr-Module/index.html) |
| If you'd prefer to access the documentation locally, you can find it at. | [./docs/index.html](./docs/index.html) |
The following documentation is intended for developers.
| Description | Link |
|----------------|----------------------------|
| Documentation for the integrated framework - for developers. | [https://bugfishtm.github.io/bugfish-framework/](https://bugfishtm.github.io/bugfish-framework/) |
## ❓ Support Channels
If you encounter any issues or have questions while using this software, feel free to contact us:
- **GitHub Issues** is the main platform for reporting bugs, asking questions, or submitting feature requests: [https://github.com/bugfishtm/Bugfish-Dolibarr-Module/issues](https://github.com/bugfishtm/Bugfish-Dolibarr-Module/issues)
- **Discord Community** is available for live discussions, support, and connecting with other users: [Join us on Discord](https://discord.com/invite/y5d2px9KEw)
- **Email support** is recommended only for urgent security-related issues: [[email protected]](mailto:[email protected])
## 📢 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 link us!
* **Post on LinkedIn** – Let your professional network know about this project on [LinkedIn](https://www.linkedin.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/).
* **Tell Your Community** – Spread the word in Discord servers, Slack groups, and forums.
## 📁 Repository Structure
This table provides an overview of key files and folders related to the repository. Click on the links to access each file for more detailed information. If certain folders are missing from the repository, they are irrelevant to this project.
|Document Type|Description|
|----|-----|
| .github | Folder with github setup files. |
| [.github/CODE_OF_CONDUCT.md](./.github/CODE_OF_CONDUCT.md) | The community guidelines. |
| _changelogs | Folder for changelogs. |
| _images | Folder for project images. |
| _licenses | Folder for 3rd party licenses. |
| _releases | Folder for releases. |
| xframework | Folder with the source code. |
| docs | Folder for the documentation. |
| .gitattributes | Repository setting file. Only for development purposes. |
| .gitignore | Repository ignore file. Only for development purposes. |
| README.md | Readme of this project. You are currently looking at this file. |
| repository_reset.bat | File to reset this repository. Only for development purposes. |
| repository_update.bat | File to update this repository. Only for development purposes. |
| [CONTRIBUTING.md](CONTRIBUTING.md) | Information for contributors. |
| [CHANGELOG.md](CHANGELOG.md) | Information about changelogs. |
| [SECURITY.md](SECURITY.md) | How to handle security issues. |
| [LICENSE.md](LICENSE.md) | License of this project. |
## 📑 Changelog Information
Refer to the `_changelogs` folder for detailed insights into the changes made across different versions. The changelogs are available in **HTML format** within this folder, providing a structured record of updates, modifications, and improvements over time. Additionally, **GitHub Releases** follow the same structure and also include these changelogs for easy reference.
## 🌱 Contributing to the Project
I am excited that you're considering contributing to our project! Here are some guidelines to help you get started.
**How to Contribute**
1. Fork the repository to create your own copy.
2. Create a new branch for your work (e.g., `feature/my-feature`).
3. Make your changes and ensure they work as expected.
4. Run tests to confirm everything is functioning correctly.
5. Commit your changes with a clear, concise message.
6. Push your branch to your forked repository.
7. Submit a pull request with a detailed description of your changes.
8. Reference any related issues or discussions in your pull request.
**Coding Style**
- Keep your code clean and well-organized.
- Add comments to explain complex logic or functions.
- Use meaningful and consistent variable and function names.
- Break down code into smaller, reusable functions and components.
- Follow proper indentation and formatting practices.
- Avoid code duplication by reusing existing functions or modules.
- Ensure your code is easily readable and maintainable by others.
## 🤝 Community Guidelines
We’re on a mission to create groundbreaking solutions, pushing the boundaries of technology. By being here, you’re an integral part of that journey.
**Positive Guidelines:**
- Be kind, empathetic, and respectful in all interactions.
- Engage thoughtfully, offering constructive, solution-oriented feedback.
- Foster an environment of collaboration, support, and mutual respect.
**Unacceptable Behavior:**
- Harassment, hate speech, or offensive language.
- Personal attacks, discrimination, or any form of bullying.
- Sharing private or sensitive information without explicit consent.
Let’s collaborate, inspire one another, and build something extraordinary together!
## 🛡️ Warranty and Security
I take security seriously and appreciate responsible disclosure. If you discover a vulnerability, please follow these steps:
- **Do not** report it via public GitHub issues or discussions. Instead, please contact the [[email protected]](mailto:[email protected]) email address directly.
- Provide as much detail as possible, including a description of the issue, steps to reproduce it, and its potential impact.
I aim to acknowledge reports within **2–4 weeks** and will update you on our progress once the issue is verified and addressed.
This software is provided as-is, without any guarantees of security, reliability, or fitness for any particular purpose. We do not take responsibility for any damage, data loss, security breaches, or other issues that may arise from using this software. By using this software, you agree that We are not liable for any direct, indirect, incidental, or consequential damages. Use it at your own risk.
## 📜 License Information
The license for this software can be found in the [LICENSE.md](LICENSE.md) file. Third-party licenses are located in the ./_licenses folder. The software may also include additional licensed software or libraries.
🐟 Bugfish