diff --git a/README.md b/README.md index e1dcd2e..77ac9c2 100644 --- a/README.md +++ b/README.md @@ -1,62 +1,26 @@ -
+## About the ServerCow DNS Panel +I built this to manage my ServerCow Domains easily in one place. +It's built with [Laravel](https://laravel.com/docs/8.x/) and [Bulma CSS](https://bulma.io/documentation/) so modifications are easy to do. - +## What do you need? +1. [ServerCow API Access](https://cp.servercow.de/client/plugin/support_manager/knowledgebase/view/34/dns-api-v1/7/) +2. A Database (Click [here](https://laravel.com/docs/8.x/database#introduction) for a list of databases supported by Laravel) +3. A server to host this application on (Click [here](https://laravel.com/docs/8.x/deployment#server-requirements) for the Laravel System Requirements) +4. [Composer](https://getcomposer.org/) +5. [NodeJS/NPM](https://nodejs.org/en/download/package-manager/) -## About Laravel +## How to install +1. Clone this repository or download it as zip and extract it onto your server +2. Install the composer packages with the command ``composer install`` +3. Install the node packages with the command ``npm install`` +4. If not already done by composer copy the ``.env.example`` to ``.env`` +5. Edit the .env file to your needs (APP_NAME, APP_URL, APP_LOCALE, Database Credentials, ServerCow API Credentials) +6. Run the database migrations: ``php artisan migrate`` +7. Compile the css files: ``npm run prod`` +8. Create a backend user: ``php artisan user:create username`` +9. Point your web root to the applications ``public`` directory -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 1500 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). - -### Premium Partners - -- **[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)** -- **[Many](https://www.many.co.uk)** -- **[Webdock, Fast VPS Hosting](https://www.webdock.io/en)** -- **[DevSquad](https://devsquad.com)** -- **[Curotec](https://www.curotec.com/)** -- **[OP.GG](https://op.gg)** - -## 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). - -## Code of Conduct - -In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct). - -## Security Vulnerabilities - -If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [taylor@laravel.com](mailto:taylor@laravel.com). All security vulnerabilities will be promptly addressed. - -## License - -The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT). +## Notes +* This application currently supports english and german +* If you want to do any modifications feel free to fork this repository and make a pull request +* You can use and modify this application in every way you want :)