Update readme.md

readme.md

@@ -1,72 +1,71 @@
-<p align="center"><img src="https://laravel.com/assets/img/components/logo-laravel.svg"></p>
+# Game Hosting Panel
+![Tests](https://github.com/HugoJF/game-hosting-panel/workflows/Laravel/badge.svg)
+[![codecov](https://codecov.io/gh/HugoJF/game-hosting-panel/branch/master/graph/badge.svg)](https://codecov.io/gh/HugoJF/game-hosting-panel)
+
+Pterodactyl powered game server reselling platform.
+
+## Overview
+
+ - 🚀 **Pterodactyl based**: supports any Nest installed on any Pterodactyl panel);
+
+ - ⏳  **Dynamic billing periods**: the user pays only when a server is online, per minute, hour, day, week or month;
+
+ - ☑️ **Transparent pricing**: server costs are calculated based on resource allocation;
+
+ - 💲 **Balance system**: avoid sending invoices for each server deploy, everything is pre-paid;
+
+ - 🚅 **Fast and simple**: deploy and start multiple servers in seconds;
+
+ - 🉑 **Supports 2 languages**: english and brazilian portuguese translations already implemented;
+
+ - 📝 **Battle tested**: critical parts of code are fully unit-tested and months of live environment use;
+
+ - 🤔 **Lots more**: multi-node by design, announcements, discount coupons, configurable server resources, and lots or planned features...
+
+## Screenshots
+
+#### Main user dashboard 
 
 <p align="center">
-<a href="https://travis-ci.org/laravel/framework"><img src="https://travis-ci.org/laravel/framework.svg" alt="Build Status"></a>
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://poser.pugx.org/laravel/framework/d/total.svg" alt="Total Downloads"></a>
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://poser.pugx.org/laravel/framework/v/stable.svg" alt="Latest Stable Version"></a>
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://poser.pugx.org/laravel/framework/license.svg" alt="License"></a>
+  <img src="https://i.imgur.com/yWo0l9J.png">
 </p>
 
-## About Laravel
+#### Server creation view 
 
-Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:
-
-- [Simple, fast routing engine](https://laravel.com/docs/routing).
-- [Powerful dependency injection container](https://laravel.com/docs/container).
-- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage.
-- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent).
-- Database agnostic [schema migrations](https://laravel.com/docs/migrations).
-- [Robust background job processing](https://laravel.com/docs/queues).
-- [Real-time event broadcasting](https://laravel.com/docs/broadcasting).
-
-Laravel is accessible, powerful, and provides tools required for large, robust applications.
-
-## Learning Laravel
-
-Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework.
-
-If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Laracasts contains over 1400 video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.
-
-## Laravel Sponsors
-
-We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the Laravel [Patreon page](https://patreon.com/taylorotwell).
-
-- **[Vehikl](https://vehikl.com/)**
-- **[Tighten Co.](https://tighten.co)**
-- **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)**
-- **[64 Robots](https://64robots.com)**
-- **[Cubet Techno Labs](https://cubettech.com)**
-- **[Cyber-Duck](https://cyber-duck.co.uk)**
-- **[British Software Development](https://www.britishsoftware.co)**
-- **[Webdock, Fast VPS Hosting](https://www.webdock.io/en)**
-- **[DevSquad](https://devsquad.com)**
-- [UserInsights](https://userinsights.com)
-- [Fragrantica](https://www.fragrantica.com)
-- [SOFTonSOFA](https://softonsofa.com/)
-- [User10](https://user10.com)
-- [Soumettre.fr](https://soumettre.fr/)
-- [CodeBrisk](https://codebrisk.com)
-- [1Forge](https://1forge.com)
-- [TECPRESSO](https://tecpresso.co.jp/)
-- [Runtime Converter](http://runtimeconverter.com/)
-- [WebL'Agence](https://weblagence.com/)
-- [Invoice Ninja](https://www.invoiceninja.com)
-- [iMi digital](https://www.imi-digital.de/)
-- [Earthlink](https://www.earthlink.ro/)
-- [Steadfast Collective](https://steadfastcollective.com/)
-- [We Are The Robots Inc.](https://watr.mx/)
-- [Understand.io](https://www.understand.io/)
-- [Abdel Elrafa](https://abdelelrafa.com)
-- [Hyper Host](https://hyper.host)
-
-## Contributing
-
-Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).
-
-## Security Vulnerabilities
+<p align="center">
+  <img src="https://i.imgur.com/xfpGo4C.png">
+</p>
 
-If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.
+#### Server view
 
-## License
+<p align="center">
+  <img src="https://i.imgur.com/ds5Q9hF.png">
+</p>
 
-The Laravel framework is open-source software licensed under the [MIT license](https://opensource.org/licenses/MIT).
+## Requirements
+  - PHP 7.4+
+  - MySQL/MariaDB
+  - Pterodactyl 0.7
+
+## Installation
+  - Deploy this Laravel app;
+  - If you don't have [CS:GO Pipeline](https://github.com/HugoJF/csgo-pipeline), deploy it;
+  - Add a list in your CS:GO Pipeline installation with the key `sessions` (set maximum size to at least 5k items);
+  - Setup a cronjob for the scheduler;
+  - Add your server address into the `servers` table.
+
+## .env file
+
+ - **`RELEASED`** - if `true` users are allowed to register;
+ - **`BROADCAST_DRIVER`** - set to `pusher` if you want auto-refresh on server install (and also configure Pusher credentials .env variables);
+ - **`QUEUE_CONNECTION`** - always set to `database` or something similar, lots of monitoring jobs are dispatched while creating servers;
+ - **`PAYMENT_SYSTEM_URL`** - URL for `payment-system` endpoint (this project is not public);
+ - **`PTERODACTYL_URL`** - base URL for Pterodactyl panel (don't end with /). This is used for user redirections when using clicking the `Go to panel` button;
+ - **`PTERODACTYL_API_ENDPOINT`** - endpoint used for API communication;
+ - **`PTERODACTYL_API_KEY`** - Pterodactyl **application** API key;
+ - **`PTERODACTYL_CLIENT_KEY`** - Pterodactyl **user** API key (create one using an admin account, we need this to controle server power and a few other essential things);
+ - **`SENTRY_LARAVEL_DSN`** - always a good idea to have Sentry setup;
+
+
+
+