You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Foster an environment of collaboration, support, and mutual respect.
5
+
Positive guidelines include being kind, empathetic, and respectful in all interactions. It is important to engage thoughtfully and offer constructive, solution-oriented feedback. Fostering an environment of collaboration, support, and mutual respect is essential.
9
6
10
-
**Unacceptable Behavior:**
11
-
- Harassment, hate speech, or offensive language.
12
-
- Personal attacks, discrimination, or any form of bullying.
13
-
- Sharing private or sensitive information without explicit consent.
7
+
Unacceptable behaviors include harassment, hate speech, or offensive language. Personal attacks, discrimination, or any form of bullying are not tolerated. Sharing private or sensitive information without explicit consent is strictly prohibited.
14
8
15
-
Let’s collaborate, inspire one another, and build something extraordinary together!
9
+
Together, we can partner to achieve common goals by following guidelines designed to promote effective collaboration and positive teamwork.
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+11-12Lines changed: 11 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,18 +2,19 @@
2
2
3
3
I am excited that you're considering contributing to our project! Here are some guidelines to help you get started.
4
4
5
-
## How to Contribute
5
+
We primarily accept security fixes and critical patches to maintain project stability and coherence. Feature updates are not accepted to preserve our backend architecture and overall project integrity.
6
6
7
-
1. Fork the repository to create your own copy.
8
-
2. Create a new branch for your work (e.g., `feature/my-feature`).
9
-
3. Make your changes and ensure they work as expected.
10
-
4. Run tests to confirm everything is functioning correctly.
11
-
5. Commit your changes with a clear, concise message.
12
-
6. Push your branch to your forked repository.
13
-
7. Submit a pull request with a detailed description of your changes.
14
-
8. Reference any related issues or discussions in your pull request.
7
+
Below is an example of how to contribute to this GitHub project. Please follow this guideline and all other contribution rules carefully; otherwise, your request may be denied.
15
8
16
-
## Coding Style
9
+
- Fork the repository to create your own copy.
10
+
- Create a new branch for your changes (e.g., feature/my-feature).
11
+
- Make your changes and verify everything works correctly.
12
+
- Commit your changes with clear and concise messages.
13
+
- Push your branch to your forked repository.
14
+
- Open a pull request to the main repository’s main branch with a detailed description of your changes.
15
+
- Reference any related issues or discussions in your pull request.
16
+
17
+
To ensure your implementation is effective and maintainable by other developers, please follow the code quality guidelines outlined below.
17
18
18
19
- Keep your code clean and well-organized.
19
20
- Add comments to explain complex logic or functions.
@@ -23,8 +24,6 @@ I am excited that you're considering contributing to our project! Here are some
23
24
- Avoid code duplication by reusing existing functions or modules.
24
25
- Ensure your code is easily readable and maintainable by others.
25
26
26
-
## Issues
27
-
28
27
If you encounter a bug or have an enhancement suggestion, please check the "Issues" section of our GitHub repository or visit our official website for guidance before beginning any work on it.
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.
3
+
Refer to the _changelogs folder for detailed HTML changelogs tracking updates across versions. These changelogs are also included in GitHub Releasesfor easy access.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+11-12Lines changed: 11 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,18 +2,19 @@
2
2
3
3
I am excited that you're considering contributing to our project! Here are some guidelines to help you get started.
4
4
5
-
## How to Contribute
5
+
We primarily accept security fixes and critical patches to maintain project stability and coherence. Feature updates are not accepted to preserve our backend architecture and overall project integrity.
6
6
7
-
1. Fork the repository to create your own copy.
8
-
2. Create a new branch for your work (e.g., `feature/my-feature`).
9
-
3. Make your changes and ensure they work as expected.
10
-
4. Run tests to confirm everything is functioning correctly.
11
-
5. Commit your changes with a clear, concise message.
12
-
6. Push your branch to your forked repository.
13
-
7. Submit a pull request with a detailed description of your changes.
14
-
8. Reference any related issues or discussions in your pull request.
7
+
Below is an example of how to contribute to this GitHub project. Please follow this guideline and all other contribution rules carefully; otherwise, your request may be denied.
15
8
16
-
## Coding Style
9
+
- Fork the repository to create your own copy.
10
+
- Create a new branch for your changes (e.g., feature/my-feature).
11
+
- Make your changes and verify everything works correctly.
12
+
- Commit your changes with clear and concise messages.
13
+
- Push your branch to your forked repository.
14
+
- Open a pull request to the main repository’s main branch with a detailed description of your changes.
15
+
- Reference any related issues or discussions in your pull request.
16
+
17
+
To ensure your implementation is effective and maintainable by other developers, please follow the code quality guidelines outlined below.
17
18
18
19
- Keep your code clean and well-organized.
19
20
- Add comments to explain complex logic or functions.
@@ -23,8 +24,6 @@ I am excited that you're considering contributing to our project! Here are some
23
24
- Avoid code duplication by reusing existing functions or modules.
24
25
- Ensure your code is easily readable and maintainable by others.
25
26
26
-
## Issues
27
-
28
27
If you encounter a bug or have an enhancement suggestion, please check the "Issues" section of our GitHub repository or visit our official website for guidance before beginning any work on it.
Copy file name to clipboardExpand all lines: README.md
+38-30Lines changed: 38 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,16 +10,16 @@
10
10
11
11
The Bugfish Framework, meticulously designed for web developers, prioritizes security, flexibility, and performance. Its architecture streamlines development processes, enhancing efficiency and scalability, while a dedicated community provides support and resources for developers to maximize their projects' potential.
12
12
13
-

13
+

14
14
15
-
###Requirements
15
+
##⚙️ Requirements
16
16
17
-
####PHP Version
17
+
###🐘 PHP Version
18
18
19
-
- PHP 8.3/8.4 is recommended.
19
+
- PHP 8.4 is recommended.
20
20
- You can find specific requirements in the different documentation sections of our libraries.
21
21
22
-
####PHP Modules
22
+
###🐘 PHP Modules
23
23
24
24
-**`mysqli`** – MySQL database connectivity using improved extension.
25
25
-**`gd`** – Image processing and manipulation (e.g., thumbnails).
@@ -38,7 +38,10 @@ The Bugfish Framework, meticulously designed for web developers, prioritizes sec
38
38
-**`json`** – Parses and encodes JSON data.
39
39
- You can find specific requirements in the different documentation sections of our libraries.
40
40
41
-
### PHP Functions
41
+
42
+
## 📚 Framework
43
+
44
+
### 🐘 PHP Functions
42
45
Discover a collection of indispensable PHP functions crafted for seamless integration across various projects. Witness how these functions expedite and refine coding processes within web development. Comprehensive documentation for each function is provided below. To incorporate these functions seamlessly, include the PHP files within the designated _functions subfolder in the overarching _framework folder. This strategic approach optimizes coding efficiency and enhances web project performance.
43
46
44
47
| Name | Description | License |
@@ -48,13 +51,15 @@ Discover a collection of indispensable PHP functions crafted for seamless integr
48
51
| ✅ x_cookiebanner.php | PHP code to display and manage cookie consent banners. | LGPL-2.1 |
49
52
| ✅ x_curl.php | PHP wrapper or helper functions for cURL HTTP requests. | LGPL-2.1 |
50
53
| ✅ x_eventbox.php | PHP component for displaying or managing event boxes/messages. | LGPL-2.1 |
These classes, located in /_framework/classes/x_*, are crucial for their functionality, efficiency, and thorough testing across various websites. They enhance development and save time. Note: Some classes require a database connection. They will install necessary tables automatically if configured correctly. Not all classes require MySQL; refer to the documentation for specific requirements. If MySQL is needed, provide a valid x_class_mysql object to the class.
61
+
### 🐘 PHP Classes
62
+
These classes, located in /_framework/classes/*, are crucial for their functionality, efficiency, and thorough testing across various websites. They enhance development and save time. Note: Some classes require a database connection. They will install necessary tables automatically if configured correctly. Not all classes require MySQL; refer to the documentation for specific requirements. If MySQL is needed, provide a valid x_class_mysql object to the class.
58
63
59
64
| Name | Description | License |
60
65
|------|-------------|---------|
@@ -75,7 +80,7 @@ These classes, located in /_framework/classes/x_*, are crucial for their functio
75
80
| ✅ x_class_mail | Handles mail sending operations, with a subclass for sending operation items. This class depends on x_class_phpmailer. | LGPL-2.1 |
76
81
| ✅ x_class_mail_template | Creates mail templates with substitutions and footer/header options, compatible with x_class_mail. This class makes it easier to quick prepare E-Mail Templates to build E-Mails - to send out to customers or others! | LGPL-2.1 |
77
82
| ✅ x_class_mysql | Provides MySQL database handling capabilities, along with additional features. This is another flagship of this framework. Most classes here need an x_class_mysql object to run properly. This class serves a lot in security and Error-Readability. It can make work much easier and has a Database logging system to store errors in Statements which may occur and much, much more! | LGPL-2.1 |
78
-
| ✅ x_class_phpmailer| Manages email sending operations within the framework. This class is not made by me "Bugfish". It's the PHPMailer Class you can find on: [Github](https://github.com/PHPMailer/PHPMailer)| LGPL-2.1 |
83
+
| ✅ x_class_mail_phpmailer| Manages email sending operations within the framework. This class is not made by me "Bugfish". It's the PHPMailer Class you can find on: [Github](https://github.com/PHPMailer/PHPMailer)| LGPL-2.1 |
79
84
| ✅ x_class_perm | Controls permissions for users, including single-item permission objects. You can control permissions with this and it is storage-saving. 1-n Relation. If you are in search of a permission system and you won't build one on your own, then you have found what you have searched for! | LGPL-2.1 |
80
85
| ✅ x_class_referer | Logs visitor referrers. You have some configuration functions to control how referrers will be saved into the database. | LGPL-2.1 |
81
86
| ✅ x_class_redis | Offers control over Redis functionality. With this class, you can cache content on a Redis server, which will make your website faster. This may come in handy if your website is serving mass on dynamically generated content, which does not change so fast. PHP Module REDIS is needed to run this class. | LGPL-2.1 |
@@ -85,14 +90,14 @@ These classes, located in /_framework/classes/x_*, are crucial for their functio
85
90
| ✅ x_class_zip | Enables file compression and decompression, compatible with x_class_crypt for direct encryption and decryption. PHP Module ZIP is required to run this class. | LGPL-2.1 |
86
91
| ✅ x_class_version | Fetch version information and information about the author at the currently deployed framework instance. | LGPL-2.1 |
87
92
88
-
### CSS Classes
93
+
### 🎨 CSS Classes
89
94
Introducing the "Bugfish CSS Framework" – a solution for efficient web design. Simplify your development process with a comprehensive collection of pre-built classes, designed to expedite the creation of responsive web layouts. The Bugfish CSS Framework streamlines your design experience, making it faster and more professional. To use it, include the CSS files located in the css folder.
90
95
91
96
| Name | Description | License |
92
97
|------|-------------|---------|
93
98
| ✅ xcss_xfpe.css | CSS framework with predefined classes for quick, simple styling. | LGPL-2.1 |
94
99
95
-
### Javascript Functions
100
+
### ⚛️ Javascript Functions
96
101
Access a comprehensive array of JavaScript functions designed for integration across diverse projects, enhancing coding speed and efficiency in web development. Detailed documentation for each function is provided below. To incorporate these functions, include the JavaScript file in the _javascript subfolder within the central _framework folder. This implementation optimizes your coding process and elevates your web project's performance. Simplify your coding with our library of pre-built functions and modules, crafted to expedite the creation of dynamic, interactive web applications. Find the JavaScript Function file in: /_framework/javascript/*.js!
97
102
98
103
| Name | Description | License |
@@ -116,15 +121,6 @@ If you encounter any issues or have questions while using this software, feel fr
116
121
-**Discord Community** is available for live discussions, support, and connecting with other users: [Join us on Discord](https://discord.com/invite/xCj7AEMmye)
Help us grow by sharing this project with others! You can:
122
-
123
-
***Tweet about it** – Share your thoughts on [Twitter/X](https://twitter.com) and link us!
124
-
***Post on LinkedIn** – Let your professional network know about this project on [LinkedIn](https://www.linkedin.com).
125
-
***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/).
126
-
***Tell Your Community** – Spread the word in Discord servers, Slack groups, and forums.
127
-
128
124
## 📁 Repository Structure
129
125
130
126
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.
@@ -149,6 +145,15 @@ This table provides an overview of key files and folders related to the reposito
149
145
|[SECURITY.md](SECURITY.md)| How to handle security issues. |
150
146
|[LICENSE.md](LICENSE.md)| License of this project. |
151
147
148
+
## 📢 Spread the Word
149
+
150
+
Help us grow by sharing this project with others! You can:
151
+
152
+
***Tweet about it** – Share your thoughts on [Twitter/X](https://twitter.com) and link us!
153
+
***Post on LinkedIn** – Let your professional network know about this project on [LinkedIn](https://www.linkedin.com).
154
+
***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/).
155
+
***Tell Your Community** – Spread the word in Discord servers, Slack groups, and forums.
156
+
152
157
## 📑 Changelog Information
153
158
154
159
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.
@@ -157,18 +162,19 @@ Refer to the `_changelogs` folder for detailed insights into the changes made ac
157
162
158
163
I am excited that you're considering contributing to our project! Here are some guidelines to help you get started.
159
164
160
-
**How to Contribute**
165
+
We primarily accept security fixes and critical patches to maintain project stability and coherence. Feature updates are not accepted to preserve our backend architecture and overall project integrity.
161
166
162
-
1. Fork the repository to create your own copy.
163
-
2. Create a new branch for your work (e.g., `feature/my-feature`).
164
-
3. Make your changes and ensure they work as expected.
165
-
4. Run tests to confirm everything is functioning correctly.
166
-
5. Commit your changes with a clear, concise message.
167
-
6. Push your branch to your forked repository.
168
-
7. Submit a pull request with a detailed description of your changes.
169
-
8. Reference any related issues or discussions in your pull request.
167
+
Below is an example of how to contribute to this GitHub project. Please follow this guideline and all other contribution rules carefully; otherwise, your request may be denied.
170
168
171
-
**Coding Style**
169
+
- Fork the repository to create your own copy.
170
+
- Create a new branch for your changes (e.g., feature/my-feature).
171
+
- Make your changes and verify everything works correctly.
172
+
- Commit your changes with clear and concise messages.
173
+
- Push your branch to your forked repository.
174
+
- Open a pull request to the main repository’s main branch with a detailed description of your changes.
175
+
- Reference any related issues or discussions in your pull request.
176
+
177
+
To ensure your implementation is effective and maintainable by other developers, please follow the code quality guidelines outlined below.
172
178
173
179
- Keep your code clean and well-organized.
174
180
- Add comments to explain complex logic or functions.
@@ -178,6 +184,8 @@ I am excited that you're considering contributing to our project! Here are some
178
184
- Avoid code duplication by reusing existing functions or modules.
179
185
- Ensure your code is easily readable and maintainable by others.
180
186
187
+
If you encounter a bug or have an enhancement suggestion, please check the "Issues" section of our GitHub repository or visit our official website for guidance before beginning any work on it.
188
+
181
189
## 🤝 Community Guidelines
182
190
183
191
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.
0 commit comments