Update for CorelyPHP v1.2.0 #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Dominik-developer merged 22 commits into main from new-structure+update

Feb 12, 2025

.github/workflows/php.yml

-Original file line number
+Diff line change
@@ -0,0 +1,37 @@
+    name: PHP Lint Workflow
+    on:
+      push:
+        branches:
+          - main
+      pull_request:
+        branches:
+          - main
+    jobs:
+      lint:
+        runs-on: ubuntu-latest
+        steps:
+          # 1. Fetch code from the repository
+          - name: Checkout code
+            uses: actions/checkout@v3
+          # 2. Set up PHP
+          - name: Setup PHP
+            uses: shivammathur/setup-php@v2
+            with:
+              php-version: '8.1'
+          # 3. Check PHP syntax in all files
+          - name: Lint PHP files
+            run: |
+              find . -name "*.php" -not -path "./vendor/*" -exec php -l {} \;
+          # 4. (Optional) Install Composer dependencies - useful if you add dependencies in the future
+          # - name: Install dependencies
+          #   run: composer install --no-progress --no-suggest
+          # 5. (Optional) Run unit tests - for example, PHPUnit
+          # - name: Run tests
+          #   run: vendor/bin/phpunit

CHANGELOG.md

-Original file line number
+Diff line change
@@ Expand Up / @@ -2,20 +2,20 @@ @@
     All notable changes to this project will be documented in this file.
+    ## v1.0.0 – First Release
-    ## [Unreleased]
-    Right now project is finished, I am working on fixing all the bugs and secruity issues.
+    ### New in v1.0.0
+    The project is ready for use but is still evolving. Work is ongoing to fix bugs and address security issues.
     ### Added
     <!-- - Initial examples of added changelog entries. -->
-    --
+    .....
     ### Changed
     <!-- - Improved existing changelog entries for consistency. -->
-    --
+    .....
     ### Fixed
     <!-- - Bugs identified in the initial release. -->
-    --
-    ## [pre release] - 2024-10-30
-    ### Added
-    The only functionalities that are added right now are fix patches for media queries, secruity reasons bugs fixing.
+    .....

CONTRIBUTING.md

-Original file line number
+Diff line change
@@ -1,104 +1,31 @@
-    # Contributing to PHP_CMS_for_blog
+    # Contributing to CorelyPHP
+    First off, thank you for considering contributing to [CorelyPHP](https://github.com/Dominik-developer/CorelyPHP)! 🎉 Your help is greatly appreciated.
-    First off, thank you for considering contributing to [PHP_CMS_for_blog](https://github.com/Dominik-developer/PHP_CMS_for_blog)! 🎉 Your help is greatly appreciated.
     ## If you've found a bug, please create an issue following these steps:
-. **Check for duplicates:** Search [existing issues](https://github.com/Dominik-developer/PHP_CMS_for_blog/issues) to ensure it hasn’t been reported.
-. **If it’s a new issue:**
-       - Open a new issue.
-         - Provide a detailed description of the bug.
-         - The version of the project you’re using.
-         - Steps to reproduce it.
-         - Expected vs. actual behavior.
-         - Screenshots or logs (if applicable/possible).
-         - Environment details (e.g., OS, browser).
-. **Remeber to follow** [Style Guides](https://github.com/Dominik-developer/PHP_CMS_for_blog/blob/main/STYLE_GUIDES.md) for this softwere.
-    ## How to Suggest a Feature
-. **Search existing suggestions:** Ensure your idea isn’t already suggested in [existing issues](https://github.com/Dominik-developer/PHP_CMS_for_blog/issues).
-. **If it’s a new idea:**
+. **Check for duplicates:** Search [existing issues](https://github.com/Dominik-developer/CorelyPHP/issues) to ensure it hasn’t been reported.
+. **If it’s a new issue:**
        - Open a new issue.
-         - Add clear title and description.
-         - Explain why the feature is needed and what problem it solves.
-         - Describe how the feature might work or look.
-         - Potential implementation ideas.
-. **Remeber to follow** [Style Guides](https://github.com/Dominik-developer/PHP_CMS_for_blog/blob/main/STYLE_GUIDES.md) for this softwere.
-    <!--
-    ## How to Submit a Pull Request
-. Fork the repository.
-. Create a new branch for your changes:
-       ```bash
-       git checkout -b feature/YourFeatureName
-    -->
-    ## Code of Conduct
-    Please read our [Code of Conduct](CODE_OF_CONDUCT.md) to understand the expectations for participation in this project.
-    <!-- NEW VERSION IN PROGRESS
-    ## Table of Contents
-    - [Code of Conduct](#code-of-conduct)
-    - [How Can I Contribute?](#how-can-i-contribute)
-      - [Reporting Bugs](#reporting-bugs)
-      - [Suggesting Enhancements](#suggesting-enhancements)
-      - [Pull Requests](#pull-requests)
-    - [Style Guides](#style-guides)
-      - [Coding Style](#coding-style)
-      - [Commit Messages](#commit-messages)
-    - [Testing](#testing)
-    - [Project Structure](#project-structure)
-    - [Additional Notes](#additional-notes)
-    ## Code of Conduct
-    -->
-    <!-- Add a link to the project's Code of Conduct document or briefly explain the expected behavior -->
-    <!--Please read our [Code of Conduct](CODE_OF_CONDUCT.md) to understand the expectations for participation in this project.
-    ## How Can I Contribute?
-    ### Reporting Bugs
-    -->
-    <!-- Instructions for reporting bugs -->
-    <!--
-    If you've found a bug, please create an issue following these steps:
-. **Check for duplicates:** Search [existing issues](https://github.com/Dominik-developer/PHP_CMS_for_blog/issues) to ensure it hasn’t been reported.
-. **Provide detailed information:** Include:
-       - Description of the bug.
+       - Provide a detailed description of the bug.
+       - The version of the project you’re using.
        - Steps to reproduce it.
        - Expected vs. actual behavior.
-       - Screenshots or logs (if applicable).
+       - Screenshots or logs (if applicable/possible).
        - Environment details (e.g., OS, browser).
+. **Remember to follow** [Style Guides](https://github.com/Dominik-developer/CorelyPHP/STYLE_GUIDES.md) for this software.
+    ## How to Suggest a Feature
-    ### Suggesting Enhancements
-    -->
-    <!-- Instructions for suggesting new features or improvements -->
-    <!--
-    We welcome ideas for improvements. To propose a feature:
-. **Search existing suggestions:** Ensure your idea isn’t already suggested in [existing issues](https://github.com/Dominik-developer/PHP_CMS_for_blog/issues).
-. **Create a new issue:** Provide:
-       - Clear title and description.
-       - Use cases explaining why the feature is useful.
+. **Search existing suggestions:** Ensure your idea isn’t already suggested in [existing issues](https://github.com/Dominik-developerCorelyPHP/issues).
+. **If it’s a new idea:**
+       - Open a new issue.
+       - Add a clear title and description.
+       - Explain why the feature is needed and what problem it solves.
+       - Describe how the feature might work or look.
        - Potential implementation ideas.
+. **Remember to follow** [Style Guides](https://github.com/Dominik-developer/CorelyPHP/STYLE_GUIDES.md) for this software.
-    ### Pull Requests
-    -->
-    <!-- Steps to create and submit pull requests -->
-    <!--
-    To contribute via code:
-. Create pull request with changes, follow Suggesting Enhancements
+    ## Code of Conduct
-. **Fork the repository.**
-. **Clone your fork:**
-       ```bash
-       git clone https://github.com/YourUsername/YourRepo.git
-    -->
+    Please read our [Code of Conduct](CODE_OF_CONDUCT.md) to understand the expectations for participation in this project.

README.md

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -1,28 +1,45 @@
  
    # PHP_CMS_for_blog

    # **CorelyPHP – PHP CMS for Blogs**

    This project is ready to deploy blog webiste with seprate admin panel to manage data.

    **CorelyPHP** is a ready-to-deploy blogging platform with a separate admin panel for managing content.

    It is written in PHP with MySQL on backend and HTML, CSS and JavaScript on frontend.

    This project is built using:  

    - **Backend:** PHP with MySQL  

    - **Frontend:** HTML, CSS, JavaScript  

    All files all devided into 4 groups:

    ## **Project Structure**  

    * admin - with all admin side files

    * docs - with documentation

    * public - with all user side files  

    * rest - all md files and license

    This way of deviding files allows to not damage backend files while rebuilding fronend.

    The only concern is implemetation of PHP functions and HTML code that is deliverd by functions.

    But this may be easly fixed specialy that when rebuilding frontend you will want other data so queries may need some improvment or rebuild.

    All files are divided into the following sections:  

    I am still working to make sure this project is 100% secure,, responisve, functional, elegant and the possibly the best I can make it.

    - **`admin/`** – Contains all admin-side files  

    - **`docs/`** – Holds documentation  

    - **`public/`** – Contains user-facing files  

    Senior Dev probably will tell that few things could be build differnt or better, probably but all things I learned druring building this project will implemented in next one, plus I upgreade codebase all the time when I find easier or better way to write sometinng but I am limited by time.  

    This structured approach helps prevent backend modifications while rebuilding the frontend. The only challenge is the integration of PHP functions that generate HTML dynamically, but this can be adjusted when refining queries and templates.

    ## Current version: v1.0.0

    ## **Development Status**  

    This version number means which version should be used. Release version sometimes may just have small patches that are not worth rebuilding to new V. But make sure you read what is changing so you know what is going on.

    I am continuously improving **CorelyPHP** to make it:  

    ✔ Secure  

    ✔ Responsive  

    ✔ Fully functional  

    ✔ Elegant  

    ✔ Efficient  

    ## INFO

    This project is a work in progress, and while some parts may be improved or rewritten in future updates, it is stable and ready for use. Contributions and feedback are always welcome!

    Check SECRUITY.md and CHANGELOG.md for information about versions and other stuff.

    A more experienced developer might suggest alternative or optimized approaches. However, every lesson I’ve learned during this project will be applied to future updates and projects. I also refine the codebase whenever I find better solutions, though time constraints may limit immediate improvements.

    ## **Project Guidelines & Documentation**  

    For more details on the project, check out the following files:  

    - 📜 **[LICENSE](LICENSE)** – License terms and conditions  

    - 🛠 **[CONTRIBUTING.md](CONTRIBUTING.md)** – Guidelines for contributors  

    - 🚀 **[STYLE_GUIDES.md](STYLE_GUIDES.md)** – Code style and best practices  

    - 🔄 **[CHANGELOG.md](CHANGELOG.md)** – Version history and updates  

    - 🔐 **[SECURITY.md](SECURITY.md)** – Security policies and vulnerability reporting  

    - 🌍 **[CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)** – Community guidelines  

    ## **Current Version: v1.0.0**

    The versioning system ensures clarity on stable releases. Minor patches may not require immediate updates, but always check the **CHANGELOG.md** for details on new features and fixes.

SECURITY.md

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -1,68 +1,53 @@
  
    # Security Policy

    ‼️ Secruity sugestions should be treated as invalid not as vulnerability.

    ‼️ Security suggestions should be treated as invalid, not as vulnerabilities.

    ## Secruity Policy 

    ## Security Policy

    * Latest Releases: The newest release, currently version v1.0.0, is the only version receiving active security updates. We strongly recommend using the latest version whenever possible.

    * **Latest Releases:** The newest release, currently version v1.0.0, is the only version receiving active security updates. We strongly recommend using the latest version whenever possible.

    * Review Changelog for Updates: For minor updates or changes, please refer to the changelog to understand what has been updated or fixed.

    * **Review Changelog for Updates:** For minor updates or changes, please refer to the changelog to understand what has been updated or fixed.

    * No Backports: Security fixes are applied exclusively to the latest version. Older versions will not receive retroactive patches for vulnerabilities.

    * **No Backports:** Security fixes are applied exclusively to the latest version. Older versions will not receive retroactive patches for vulnerabilities.

    * Security Risks of Unsupported Versions: Using unsupported versions exposes you to known and unknown vulnerabilities, as they are no longer maintained or updated.

    * **Security Risks of Unsupported Versions:** Using unsupported versions exposes you to known and unknown vulnerabilities, as they are no longer maintained or updated.

    * Update Regularly: Keeping your software up to date is essential to ensure your system remains secure.

    * **Update Regularly:** Keeping your software up to date is essential to ensure your system remains secure.

    ## Supported Versions

    <!--Use this section to tell people about which versions of your project are

    currently being supported with security updates.-->

    * All safe and supported versions of our software are marked with a ✅.  

    * It is highly recommended to use only these versions, as they contain the latest security fixes and improvements. Older, unsupported versions should be avoided, as they may contain vulnerabilities that will not be addressed retroactively.  

    * New versions that do not introduce security changes will not affect the support status of previous versions.

    * All safe and supported versions of our software are marked with a ✅. <!-- It is highly recommended to use only these versions, as they contain the latest security fixes and improvements. Older, unsupported versions should be avoided, as they may contain vulnerabilities that will not be addressed retroactively.-->

    * New versions that do not introduce changes in terms of security do not affect the lack of support for previous versions.

    <!-- All versions that are safe are marked with :white_check_mark: mark. Please avoid using older versions because all security issues have been fixed in the latest releases. Solutions to these issues won’t be retrofitted to earlier versions, and support does not address past vulnerabilities. The newest release is the version that is currently supported with secruity updates.

    For this moment it is v1.0.0 version. Keeping our software up to date is essential for security. Thanks!-->

    | Version | Supported          |

    | ------- | ------------------ |

    | pre release   | :negative_squared_cross_mark:  |

    | Version       | Supported          |

    | ------------- | ------------------ |

    | pre-release   | :negative_squared_cross_mark:  |

    | v0.1.0-beta   | :white_check_mark: |

    | v1.0.0   | :white_check_mark: |

    <!--| 5.0.x   | :x:                |

    | 4.0.x   | :white_check_mark: |

    | < 4.0   | :x:                |-->

    | v1.0.0        | :white_check_mark: |

    ## Reporting a Vulnerability

    <!--Use this section to tell people how to report a vulnerability.

    Tell them where to go, how often they can expect to get an update on a

    reported vulnerability, what to expect if the vulnerability is accepted or

    declined, etc.-->

    ‼️ Please report only one vulnerability ot once unless it is really connected.

    To report vulnerability:

    * create issue

    * in title write 'Vulnerability' and which part it affects: admin/user/other and how serious it is  

    * tag me

    * add 'Vulnerability' label / bug label or invalid label

    * write description:

      * short summary

      * which part of the repository is affected

      * in which version it happend

      * how serious it is  

      * what type of vulnerability it is

      * how did you find it/ how it happend

    * if you know how to solve the issue please be welcome to propose the solution

      * propose solution here in issue or by pull request

      * if u decide to create pull request, add note here in pr that this pr fixes this specific issue described here  

    * publish aaaand done!

    * I may comment on your issue so please turn on notifications because I will comment

      Thank you for reporting issues and making the project more sefe.

      Thankful main developer: Dominik-developer  

    ‼️ Please report only one vulnerability at a time, unless it is genuinely connected to another issue.

    To report a vulnerability:

    * Create an issue.

    * In the title, write "Vulnerability" and specify which part it affects (admin/user/other) and how serious it is.

    * Tag me in the issue.

    * Add the "Vulnerability" label, or a "Bug" label, or an "Invalid" label if it’s not valid.

    * Write a detailed description:

      * A short summary of the vulnerability.

      * Which part of the repository is affected.

      * In which version the vulnerability occurs.

      * How serious the vulnerability is.

      * What type of vulnerability it is (e.g., XSS, SQL injection, etc.).

      * How you found the issue and how it happened.

    * If you know how to fix the issue, feel free to propose a solution:

      * Propose a solution in the issue or via a pull request.

      * If submitting a pull request, please note in the PR description that it fixes this specific issue.

    * Publish the issue and you’re done!

    * I may comment on your issue, so please turn on notifications to stay updated.

    Thank you for reporting issues and helping make the project more secure!  

    — Main developer: Dominik-developer

STYLE_GUIDES.md

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -1,9 +1,11 @@
  
    # Style Guides for PHP CMS for blog

    # Style Guides for CorelyPHP

    This document outlines the coding and formatting standards to be followed when contributing to [PHP_CMS_for_blog](https://github.com/Dominik-developer/PHP_CMS_for_blog).

    This document outlines the coding and formatting standards to be followed when contributing to [CorelyPHP](https://github.com/Dominik-developer/CorelyPHP).

    This guideline is still in development and probaby will take a while before it will appears here because project is private now on GitHub. 

    If you nedd help create issue with label 'documentation' and tag Dominik-developer. 

    <!--

    ## Table of Contents

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update for CorelyPHP v1.2.0 #7

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!