From d5ffe982d8c4f0ee21b4cddbea6abd0176531963 Mon Sep 17 00:00:00 2001 From: S0ly Date: Tue, 30 Apr 2024 14:28:48 +0200 Subject: [PATCH 01/21] UPDATE: moved building.md to a readme in the developement docker --- BUILDING.md => docker/README.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename BUILDING.md => docker/README.md (100%) diff --git a/BUILDING.md b/docker/README.md similarity index 100% rename from BUILDING.md rename to docker/README.md From 75c6dfcb798089bb188493bb395359f2d734eca0 Mon Sep 17 00:00:00 2001 From: S0ly Date: Tue, 30 Apr 2024 14:29:03 +0200 Subject: [PATCH 02/21] UPDATE: moved contributing.md to .github --- CONTRIBUTING.md => .github/CONTRIBUTING.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename CONTRIBUTING.md => .github/CONTRIBUTING.md (100%) diff --git a/CONTRIBUTING.md b/.github/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING.md rename to .github/CONTRIBUTING.md From 5c32ff24912bfeac82a11d039a0b50a80482e2cc Mon Sep 17 00:00:00 2001 From: S0ly Date: Tue, 30 Apr 2024 14:29:18 +0200 Subject: [PATCH 03/21] ADD: empty code of conduct in .github --- .github/CODE_OF_CONDUCT.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 .github/CODE_OF_CONDUCT.md diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..e69de29b From bc190dceb6f62229c5018fabc07c50207c2bda16 Mon Sep 17 00:00:00 2001 From: S0ly Date: Tue, 30 Apr 2024 14:41:18 +0200 Subject: [PATCH 04/21] FIX: bug and feature displaying differently --- .github/ISSUE_TEMPLATE/bug.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 24b38f4f..f9e8e9ec 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -1,6 +1,6 @@ name: "\U0001F41B Bug report" description: Create a report to help us improve -title: "[Bug]: " +title: "[Bug] " labels: ["bug"] body: - type: textarea From 971458a01b8d5a35c66730d051c244441f035c51 Mon Sep 17 00:00:00 2001 From: S0ly Date: Tue, 30 Apr 2024 14:46:10 +0200 Subject: [PATCH 05/21] ADD: empty issue template --- .github/PULL_REQUEST_TEMPLATE.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..e69de29b From 37e505c37eb286fc9d62b32839ed6f360dea7b4c Mon Sep 17 00:00:00 2001 From: S0ly Date: Mon, 6 May 2024 11:52:52 +0200 Subject: [PATCH 06/21] REMOVE: empty composer file at root --- composer | 0 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 composer diff --git a/composer b/composer deleted file mode 100644 index e69de29b..00000000 From 077ee2c7e4b325257dd3d160f161f931941c5347 Mon Sep 17 00:00:00 2001 From: S0ly Date: Mon, 6 May 2024 11:54:03 +0200 Subject: [PATCH 07/21] REMOVE: strange unused test.json file --- test.json | 12 ------------ 1 file changed, 12 deletions(-) delete mode 100644 test.json diff --git a/test.json b/test.json deleted file mode 100644 index e0ff4215..00000000 --- a/test.json +++ /dev/null @@ -1,12 +0,0 @@ -[ - { - "PASSWORD": "", - "USERNAME": "", - "AUTO_UPDATE": "0", - "BOT_PY_FILE": "bot.py", - "PY_PACKAGES": "", - "USER_UPLOAD": "0", - "INSTALL_REPO": "", - "INSTALL_BRANCH": "" - } -] From 3656c8169d74300c8a3be2a52f3ee5067738066d Mon Sep 17 00:00:00 2001 From: S0ly Date: Mon, 6 May 2024 11:59:44 +0200 Subject: [PATCH 08/21] UPDATE: cleared and documented git files --- .gitattributes | 5 +++++ .gitignore | 35 ++++++++++++++++++++--------------- 2 files changed, 25 insertions(+), 15 deletions(-) diff --git a/.gitattributes b/.gitattributes index 967315dd..2f74b7dd 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,5 +1,10 @@ +# Automatically detect text files * text=auto + +# Vendored files for specific languages *.css linguist-vendored *.scss linguist-vendored *.js linguist-vendored + +# Ignore CHANGELOG.md when exporting CHANGELOG.md export-ignore diff --git a/.gitignore b/.gitignore index ad9d095b..f72249a8 100644 --- a/.gitignore +++ b/.gitignore @@ -1,29 +1,34 @@ +# Ignore dependencies and cache /node_modules +/vendor +/storage/*.key + +# Ignore public assets /public/hot /public/storage -/storage/*.key -/vendor -/storage/credit_deduction_log -storage/debugbar +/storage/app/public/logo.png + +# Ignore environment files and configuration .env .env.testing .env.backup -.idea +.env.dev + +# Ignore testing and debug logs .phpunit.result.cache -.editorconfig -docker-compose.override.yml -Homestead.json -Homestead.yaml npm-debug.log yarn-error.log yarn.lock + +# Ignore Docker and Homestead configuration +docker-compose.override.yml +Homestead.json +Homestead.yaml + +# Ignore gitignore itself .gitignore -.env.dev -.env.testing -storage/invoices.zip -storage/app/public/logo.png -*vscode - - Kopie.env + +# Ignore installation logs and locks public/install/logs.txt install.lock public/install/logs/installer.log From f18e8c817774edfde0475439065ab0f60aa2c241 Mon Sep 17 00:00:00 2001 From: S0ly Date: Mon, 6 May 2024 11:59:57 +0200 Subject: [PATCH 09/21] UPDATE: cleared and documented .env.exemple --- .env.example | 42 ++++++++++++++++++++++-------------------- 1 file changed, 22 insertions(+), 20 deletions(-) diff --git a/.env.example b/.env.example index 98f9662b..46f1a273 100644 --- a/.env.example +++ b/.env.example @@ -4,25 +4,24 @@ APP_ENV=production APP_KEY= APP_DEBUG=false APP_URL=http://localhost -# List with timezones https://www.php.net/manual/en/timezones.php -APP_TIMEZONE=UTC +APP_TIMEZONE=UTC # List with timezones https://www.php.net/manual/en/timezones.php ### --- App Settings End --- ### -### --- DB Settings (required) --- ### +### --- Database Settings (required) --- ### DB_CONNECTION=mysql DB_HOST=127.0.0.1 DB_PORT=3306 DB_DATABASE=dashboard DB_USERNAME=dashboarduser DB_PASSWORD= -### --- DB Settings End --- ### +### --- Database Settings End --- ### - -# Google Recaptcha API Credentials - https://www.google.com/recaptcha/admin - reCaptcha V2 (not v3) +### --- Google Recaptcha Settings --- ### RECAPTCHA_SITE_KEY=6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI RECAPTCHA_SECRET_KEY=6LeIxAcTAAAAAGG-vFI1TnRWxMZNFuojJ4WifJWe +### --- Google Recaptcha Settings End --- ### -# Mail Server Settings - (HOST -> SMTP Server) +### --- Mail Server Settings --- ### MAIL_MAILER=smtp MAIL_HOST=mailhog MAIL_PORT=1025 @@ -31,25 +30,22 @@ MAIL_PASSWORD=null MAIL_ENCRYPTION=null MAIL_FROM_ADDRESS=null MAIL_FROM_NAME="${APP_NAME}" +### --- Mail Server Settings End --- ### - -# Laravel Logging Settings - https://laravel.com/docs/5.7/logging - Not needed to be changed +### --- Logging Settings --- ### LOG_CHANNEL=stack LOG_LEVEL=debug +### --- Logging Settings End --- ### -# Do not change anything below this line -BROADCAST_DRIVER=log +### --- Cache and Queue Settings --- ### CACHE_DRIVER=file QUEUE_CONNECTION=database SESSION_DRIVER=file SESSION_LIFETIME=120 +SETTINGS_CACHE_ENABLED=true +### --- Cache and Queue Settings End --- ### -MEMCACHED_HOST=127.0.0.1 - -REDIS_HOST=127.0.0.1 -REDIS_PASSWORD=null -REDIS_PORT=6379 - +### --- External Services Credentials --- ### AWS_ACCESS_KEY_ID= AWS_SECRET_ACCESS_KEY= AWS_DEFAULT_REGION=us-east-1 @@ -59,9 +55,15 @@ PUSHER_APP_ID= PUSHER_APP_KEY= PUSHER_APP_SECRET= PUSHER_APP_CLUSTER=mt1 +### --- External Services Credentials End --- ### + +### --- Additional Configuration --- ### +MEMCACHED_HOST=127.0.0.1 + +REDIS_HOST=127.0.0.1 +REDIS_PASSWORD=null +REDIS_PORT=6379 MIX_PUSHER_APP_KEY="${PUSHER_APP_KEY}" MIX_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}" - -# Settings Cache -SETTINGS_CACHE_ENABLED=true +### --- Additional Configuration End --- ### From b2ee49f534059cc75115f2702970413f4adf94f8 Mon Sep 17 00:00:00 2001 From: S0ly Date: Mon, 6 May 2024 12:02:18 +0200 Subject: [PATCH 10/21] UPDATE: de-mixed the code of conduct from the contribute file --- .github/CODE_OF_CONDUCT.md | 25 +++++++++++++++++++++++++ .github/CONTRIBUTING.md | 26 -------------------------- 2 files changed, 25 insertions(+), 26 deletions(-) diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md index e69de29b..1714350a 100644 --- a/.github/CODE_OF_CONDUCT.md +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,25 @@ +## Code of Conduct + +### Our Pledge +In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + +### Coding Style + +We are following the PSR12 code standard for PHP. + +### Our Standards +Examples of behavior that contributes to creating a positive environment include: + +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +- The use of sexualized language or imagery and unwelcome sexual attention or advances +- Trolling, insulting/derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or electronic address, without explicit permission +- Other conduct which could reasonably be considered inappropriate in a professional setting diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 74ddb1f9..c7d33644 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -15,29 +15,3 @@ php artisan translatable:export en 1. Give your PR a good descriptive title, so we can view immediately what the PR is about. 2. The dev team will look at your code and approve / merge when possible. 3. Make sure your PR follows our code of conduct and coding style. - -## Code of Conduct - -### Our Pledge -In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. - -### Coding Style - -We are following the PSR12 code standard for PHP. - -### Our Standards -Examples of behavior that contributes to creating a positive environment include: - -- Using welcoming and inclusive language -- Being respectful of differing viewpoints and experiences -- Gracefully accepting constructive criticism -- Focusing on what is best for the community -- Showing empathy towards other community members - -Examples of unacceptable behavior by participants include: - -- The use of sexualized language or imagery and unwelcome sexual attention or advances -- Trolling, insulting/derogatory comments, and personal or political attacks -- Public or private harassment -- Publishing others' private information, such as a physical or electronic address, without explicit permission -- Other conduct which could reasonably be considered inappropriate in a professional setting From 0f138cab1dffd0c046b6854d2ae8133210e2f2f3 Mon Sep 17 00:00:00 2001 From: S0ly Date: Mon, 6 May 2024 12:13:35 +0200 Subject: [PATCH 11/21] ADD: basic Pull request tempalte --- .github/PULL_REQUEST_TEMPLATE.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index e69de29b..50d3e388 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,31 @@ +⚠️ Please be sure that you have read pull request rules. + +Tick the checkbox if you understand [x]: +- [ ] I have read and understand the pull request rules. + +# Description + +Fixes #(issue) + +## Type of change + +Please delete any options that are not relevant. + +- Bug fix (non-breaking change which fixes an issue) +- User interface (UI) +- New feature (non-breaking change which adds functionality) +- Breaking change (a fix or feature that would cause existing functionality to not work as expected) +- Other +- This change requires a documentation update + +## Checklist + +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my own code and tested it +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] My changes generates no new warnings +- [ ] My code needed automated testing. I have added them (this is optional task) + +## Screenshots (if any) + +Please do not use any external image service. Instead, just paste in or drag and drop the image here, and it will be uploaded automatically. \ No newline at end of file From 9b45d76b445cf166c16c1ab026d967a8cabb2ee5 Mon Sep 17 00:00:00 2001 From: S0ly Date: Mon, 6 May 2024 12:30:52 +0200 Subject: [PATCH 12/21] ADD: Basic Security Policy --- .github/SECURITY.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 .github/SECURITY.md diff --git a/.github/SECURITY.md b/.github/SECURITY.md new file mode 100644 index 00000000..e3c6ecee --- /dev/null +++ b/.github/SECURITY.md @@ -0,0 +1,17 @@ +# Security Policy + +## Reporting a Vulnerability + +Please report security issues to ... + +Do not use the public issue tracker or discuss it in public as it will cause more damage. + +## Do you accept other 3rd-party bug bounty platforms? + +At this moment, we do not accept other bug bounty platforms, please report through GitHub Advisories only. We will ignore all 3rd-party bug bounty platforms emails. + +## Supported Versions + +### ControlPanel Versions + +You should use or upgrade to the latest version of ControlPanel. From 44a6946c44257bb5dc781c024c1d75003c3c0f6f Mon Sep 17 00:00:00 2001 From: S0ly Date: Tue, 7 May 2024 09:59:15 +0200 Subject: [PATCH 13/21] UPDATE: made a better security policy --- .github/SECURITY.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/SECURITY.md b/.github/SECURITY.md index e3c6ecee..278e81e7 100644 --- a/.github/SECURITY.md +++ b/.github/SECURITY.md @@ -2,16 +2,16 @@ ## Reporting a Vulnerability -Please report security issues to ... +🛡️ If you discover a security vulnerability, please report it to us via GitHub Advisories. -Do not use the public issue tracker or discuss it in public as it will cause more damage. +⚠️ Please refrain from using the public issue tracker or discussing the vulnerability in public channels, as it may exacerbate the issue. -## Do you accept other 3rd-party bug bounty platforms? +## Acceptance of Bug Bounty Platforms -At this moment, we do not accept other bug bounty platforms, please report through GitHub Advisories only. We will ignore all 3rd-party bug bounty platforms emails. +At this time, we only accept vulnerability reports through GitHub Advisories. We kindly ask that you do not submit reports via other third-party bug bounty platforms, as they will be disregarded. ## Supported Versions ### ControlPanel Versions -You should use or upgrade to the latest version of ControlPanel. +We strongly recommend using or upgrading to the latest version of ControlPanel to ensure you have access to the latest security fixes and enhancements. From f12ab58c8e0d3cb91e4a44b403a71f0db68fbec8 Mon Sep 17 00:00:00 2001 From: S0ly Date: Tue, 7 May 2024 09:59:27 +0200 Subject: [PATCH 14/21] UPDATE: made a better code of conduct --- .github/CODE_OF_CONDUCT.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md index 1714350a..6b807f42 100644 --- a/.github/CODE_OF_CONDUCT.md +++ b/.github/CODE_OF_CONDUCT.md @@ -1,13 +1,10 @@ ## Code of Conduct -### Our Pledge -In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. +### 🤝 Our Pledge -### Coding Style +In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. -We are following the PSR12 code standard for PHP. - -### Our Standards +### 🌟 Our Standards Examples of behavior that contributes to creating a positive environment include: - Using welcoming and inclusive language From cad6361e492e312dcd011ef6ff59c477a6b84618 Mon Sep 17 00:00:00 2001 From: S0ly Date: Tue, 7 May 2024 09:59:39 +0200 Subject: [PATCH 15/21] UPDATE: made a better contributing policy --- .github/CONTRIBUTING.md | 33 +++++++++++++++++++++++++-------- 1 file changed, 25 insertions(+), 8 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index c7d33644..ff44e211 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,17 +1,34 @@ -# Contributing +# Contributing Guidelines -When contributing to this repository, please go through the open issues to see if you can contribute to something. If you want to contribute something that is not in the issues you can make an issue and wait for response from the dev team. +Thank you for considering contributing to this repository! Before making a contribution, please take a moment to review the following guidelines. -Please note we have a code of conduct, please follow it in all your interactions with the project. +## 🕵️‍♂️ Finding Tasks -If you added any Strings which are displayed at the frontend please localize them (e.g. "New String" -> {{ __('New String') }}) and run the localization string generation: +Check the open issues to see if there's something you can contribute to. If you have an idea or encounter a bug that's not already listed, feel free to create a new issue and wait for feedback from the development team. +## 🤝 Code of Conduct + +Please adhere to our [Code of Conduct](link-to-code-of-conduct) in all your interactions with the project. + +## 🌍 Localization + +If you add any strings that are displayed on the frontend, please localize them using the following format: +``` +"New String" -> {{ __('New String') }} +``` +After adding localized strings, run the following command to generate localization files: ```cmd php artisan translatable:export en ``` -## Pull request process +## 🚀 Pull Request Process -1. Give your PR a good descriptive title, so we can view immediately what the PR is about. -2. The dev team will look at your code and approve / merge when possible. -3. Make sure your PR follows our code of conduct and coding style. +1. Give your pull request (PR) a clear and descriptive title that summarizes the changes. +2. The development team will review your code and provide feedback or approve/merge it when appropriate. +3. Ensure that your PR follows our Code of Conduct and coding style guidelines. + +### 💻 Coding Style + +We follow the PSR12 code standard for PHP. + +Thank you for your contributions! 🎉 From 14e200f88e655a6f337677d7baf03854b90a7123 Mon Sep 17 00:00:00 2001 From: S0ly Date: Tue, 7 May 2024 09:59:50 +0200 Subject: [PATCH 16/21] UPDATE: made a better pull request template --- .github/PULL_REQUEST_TEMPLATE.md | 38 ++++++++++++++++++-------------- 1 file changed, 21 insertions(+), 17 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 50d3e388..095ada5e 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,31 +1,35 @@ -⚠️ Please be sure that you have read pull request rules. +✨ Thank you for your contribution to our project! Before you submit your pull request, please take a moment to review and complete the following -Tick the checkbox if you understand [x]: -- [ ] I have read and understand the pull request rules. +⚠️ Please modify this template below and if not already one, read our pull request rules, Thanks! -# Description +Ensure that your pull request meets the following criteria: -Fixes #(issue) +- The code follows the style guidelines of this project +- You have performed a self-review of your own code and tested it +- You have commented your code, particularly in hard-to-understand areas +- Your changes generate no new warnings -## Type of change +--- -Please delete any options that are not relevant. +💡 **Description** + +Briefly describe the purpose of your pull request, including any relevant issue numbers it addresses. + +--- + +🛠️ **Type of Change** + +Please select the appropriate type of change: - Bug fix (non-breaking change which fixes an issue) -- User interface (UI) +- User interface (UI) improvement - New feature (non-breaking change which adds functionality) - Breaking change (a fix or feature that would cause existing functionality to not work as expected) - Other - This change requires a documentation update -## Checklist +--- -- [ ] My code follows the style guidelines of this project -- [ ] I have performed a self-review of my own code and tested it -- [ ] I have commented my code, particularly in hard-to-understand areas -- [ ] My changes generates no new warnings -- [ ] My code needed automated testing. I have added them (this is optional task) +🖼️ **Screenshots (if applicable)** -## Screenshots (if any) - -Please do not use any external image service. Instead, just paste in or drag and drop the image here, and it will be uploaded automatically. \ No newline at end of file +If your pull request includes any visual changes, please provide screenshots here, do not use any external link. From 5ea4ceda6babd1468791b41c470ca53e71d36b54 Mon Sep 17 00:00:00 2001 From: S0ly Date: Tue, 7 May 2024 10:00:00 +0200 Subject: [PATCH 17/21] UPDATE: made a better main readme --- README.md | 100 +++++++++++++++++++++++++++++++----------------------- 1 file changed, 57 insertions(+), 43 deletions(-) diff --git a/README.md b/README.md index c121ff78..092ac217 100644 --- a/README.md +++ b/README.md @@ -1,67 +1,81 @@ -### Features - -- PayPal, Stripe and Mollie Integration -- Hourly, Weekely, Monthly, Quarterly and Annual billing Cycles -- Referral System -- Partner System -- Ticket System -- Upgrade/Downgrade Server Resources -- Store (credit system with hourly billing and invoices) -- Email Verification -- Audit Log -- Admin Dashboard -- User/Server Management -- Customisable server plans -- Vouchers -- Alert System -- Theme Support -- and so much more! +
+ +
# CtrlPanel-gg -![ctrlpanel](https://user-images.githubusercontent.com/67899387/214684708-739c1d21-06e8-4dec-a4f1-81533a46cc7e.png) +CtrlPanel offers an easy-to-use and free billing solution for all starting and experienced hosting providers that seamlessly integrates with the Pterodactyl panel. It facilitates account creation, server ordering, and management, while offering addons, multiple payment methods, and customizable themes for a comprehensive solution. +![GitHub tag](https://img.shields.io/github/tag/ControlPanel-gg/dashboard) +![Overall Installations](https://img.shields.io/badge/Overall%20Installations-5000%2B-green) +![GitHub stars](https://img.shields.io/github/stars/ControlPanel-gg/dashboard) +[![Crowdin](https://badges.crowdin.net/controlpanelgg/localized.svg)](https://crowdin.com/project/controlpanelgg) +![License](https://img.shields.io/github/license/ControlPanel-gg/dashboard) +![Discord](https://img.shields.io/discord/787829714483019826) -![](https://img.shields.io/endpoint?label=v0.9%20Installations&url=https%3A%2F%2Fmarket.ctrlpanel.gg%2Fcallhome.php%3Fgetinstalls) -![](https://img.shields.io/badge/Overall%20Installations-5000%2B-green) -![](https://img.shields.io/github/stars/ctrlpanel-gg/dashboard) ![](https://img.shields.io/github/forks/ctrlpanel-gg/panel) ![](https://img.shields.io/github/tag/ctrlpanel-gg/panel) [![Crowdin](https://badges.crowdin.com/project/controlpanelgg/localized.svg)](https://crowdin.com/project/controlpanelgg) ![](https://img.shields.io/github/issues/ctrlpanel-gg/panel) ![](https://img.shields.io/github/license/ctrlpanel-gg/panel) ![](https://img.shields.io/discord/787829714483019826) -## About +![CtrlPanel](https://user-images.githubusercontent.com/67899387/214684708-739c1d21-06e8-4dec-a4f1-81533a46cc7e.png) -CtrlPanel's Dashboard is a dashboard application designed to offer clients a management tool to manage their pterodactyl servers. This dashboard comes with a credit-based billing solution that charges users depending on the billing cycle you chose for each server they have and suspends them if they run out of credits. +## ⭐ Features -This dashboard offers an easy to use and free billing solution for all starting and experienced hosting providers. This dashboard has many customisation options and added discord Oauth verification to offer a solid link between your discord server and your dashboard. You can check our [Demo here](https://demo.CtrlPanel.gg "Demo"). +- Store (credit system with hourly billing and invoices) +- Many Popular Payment Methods +- Referral +- Partner +- Vouchers +- Ticket +- Account Management +- Admin Dashboard and Tools +- Addon Support +- and more! -### [Installation](https://ctrlpanel.gg/docs/intro "Installation") +## ⛰️ Live Demo -### [Updating](https://ctrlpanel.gg/docs/Installation/updating "Updating") +Try it! -### [Discord](https://discord.gg/4Y6HjD2uyU "Discord") +Demo Server: [demo.CtrlPanel.gg](https://demo.CtrlPanel.gg) -### [Contributing](https://ctrlpanel.gg/docs/Contributing/contributing "Contributing") +It is a temporary live demo; all data will be deleted. -### [Donating](https://ctrlpanel.gg/docs/Contributing/donating "Donating") +## 🔧 How to Install +### 🐳 Docker +```bash +docker run ... +``` -# Preview +CtrlPanel is now running on [0.0.0.0:3001](http://0.0.0.0:3001). Don't forget to configure the database and Pterodactyl. [Documentation](documentation link here) -### Server Creation -![image](https://user-images.githubusercontent.com/67899387/214687234-d1ae58c0-5667-4e99-ac39-adeaabfcc7f2.png) +more info: [Docker](docker documentation link here) -### Overview -![image](https://user-images.githubusercontent.com/67899387/214685859-03c8d9e1-c685-4a07-979f-df2e88ec3931.png) +### 💪🏻 Non-Docker -### Example server products -![image](https://user-images.githubusercontent.com/67899387/214686950-218e1ede-6a1f-4e53-b3f4-fe1abc371a9c.png) +Requirements: -### Ticket System -![image](https://user-images.githubusercontent.com/67899387/214687123-0a3d0f8f-b53c-4b0d-869a-4d5df45f5184.png) +- Platform + - Major Linux distros such as Debian, Ubuntu, CentOS, Fedora, and ArchLinux etc. + - Windows 10 (x64), Windows Server ... -### Voucher System -![image](https://user-images.githubusercontent.com/67899387/214686578-ec9f0b0f-6047-4665-835f-70594b56dfd5.png) +Follow the [documentation](documentation link here) to know how to install. -### Partner System -![image](https://user-images.githubusercontent.com/67899387/214686321-36ba97a3-4181-4e60-9ba3-c9b318fe66a8.png) +### MarketPlace +If you need more functionality, check out [Marketplace](https://market.ctrlpanel.gg/resources/). +## 🆙 How to Update +Please read: [Update Instructions](https://ctrlpanel.gg/docs/Installation/updating) + +## 🆕 What's Next? + +Roadmap: [CtrlPanel Roadmap](https://github.com/orgs/Ctrlpanel-gg/projects/1) + +## 🗣️ Discussion / Ask for Help + +For any general or technical questions, join CtrlPanel Discord for finding answers to your question. If you cannot find the information you need, feel free to ask. + +## 🤝 Contributing + +Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us. + +Thanks to all contributors and supporters! From 8c98acb20a5a0d9bc93ba5c1d7a228b9e8311191 Mon Sep 17 00:00:00 2001 From: S0ly Date: Tue, 7 May 2024 10:18:22 +0200 Subject: [PATCH 18/21] FIX: links in main readme --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 092ac217..36c11d00 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@
- +
# CtrlPanel-gg @@ -34,19 +34,21 @@ Try it! Demo Server: [demo.CtrlPanel.gg](https://demo.CtrlPanel.gg) -It is a temporary live demo; all data will be deleted. + ## 🔧 How to Install ### 🐳 Docker -```bash +Soon... + + ### 💪🏻 Non-Docker @@ -56,7 +58,7 @@ Requirements: - Major Linux distros such as Debian, Ubuntu, CentOS, Fedora, and ArchLinux etc. - Windows 10 (x64), Windows Server ... -Follow the [documentation](documentation link here) to know how to install. +Follow the [documentation](https://ctrlpanel.gg/docs/intro) to know how to install. ### MarketPlace @@ -76,6 +78,6 @@ For any general or technical questions, join CtrlPanel Discord for finding answe ## 🤝 Contributing -Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us. +Please read [CONTRIBUTING.md](https://github.com/Ctrlpanel-gg/panel/blob/main/.github/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us. Thanks to all contributors and supporters! From f563dcdd741ed080d12d1c5fddd482143a5c5796 Mon Sep 17 00:00:00 2001 From: S0ly Date: Tue, 7 May 2024 10:19:27 +0200 Subject: [PATCH 19/21] FIX: links in contributing.md --- .github/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index ff44e211..72eb32a7 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -8,7 +8,7 @@ Check the open issues to see if there's something you can contribute to. If you ## 🤝 Code of Conduct -Please adhere to our [Code of Conduct](link-to-code-of-conduct) in all your interactions with the project. +Please adhere to our [Code of Conduct](https://github.com/Ctrlpanel-gg/panel/blob/main/.github/CODE_OF_CONDUCT.md) in all your interactions with the project. ## 🌍 Localization From 6f55e306c1dce4756a0c21d23114abcee3cbf5f1 Mon Sep 17 00:00:00 2001 From: S0ly Date: Tue, 7 May 2024 10:22:32 +0200 Subject: [PATCH 20/21] ADD: warning to default pull request text --- .github/PULL_REQUEST_TEMPLATE.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 095ada5e..89224a42 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,6 +1,6 @@ ✨ Thank you for your contribution to our project! Before you submit your pull request, please take a moment to review and complete the following -⚠️ Please modify this template below and if not already one, read our pull request rules, Thanks! +⚠️ Please modify this template below and if not already done, read our pull request rules, Thanks! Ensure that your pull request meets the following criteria: @@ -9,6 +9,8 @@ Ensure that your pull request meets the following criteria: - You have commented your code, particularly in hard-to-understand areas - Your changes generate no new warnings +Delete the above text and the following sections before submitting your pull request. + --- 💡 **Description** From 812b817968e656588f56e3a076082a03ee267051 Mon Sep 17 00:00:00 2001 From: S0ly Date: Tue, 7 May 2024 10:32:24 +0200 Subject: [PATCH 21/21] ADD: donation to the project main readme --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 36c11d00..291c86cf 100644 --- a/README.md +++ b/README.md @@ -81,3 +81,7 @@ For any general or technical questions, join CtrlPanel Discord for finding answe Please read [CONTRIBUTING.md](https://github.com/Ctrlpanel-gg/panel/blob/main/.github/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us. Thanks to all contributors and supporters! + +## ♥️ Donations + +If you like what we do, please consider [supporting](https://ctrlpanel.gg/docs/Contributing/donating) us.