diff --git a/README.md b/README.md index 729708e..ceb6ac0 100644 --- a/README.md +++ b/README.md @@ -1,77 +1,62 @@ -# Heritage WoW +

-Heritage WoW is a Laravel application for managing World of Warcraft characters and profession data. -It supports importing profession exports, browsing recipes/items, and account login with username/password or Discord OAuth. +

+Build Status +Total Downloads +Latest Stable Version +License +

-## Features +## About Laravel -- Character pages with owned professions and recipes -- Profession import pipeline (queued job) for sync/update -- Recipe and item listing pages -- Local authentication and Discord OAuth login -- Admin-only user management routes +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: -## Stack +- [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). -- PHP/Laravel: Laravel 8 -- Frontend: Blade + Tailwind CSS + Alpine.js -- Build tooling: Laravel Mix -- Database: MySQL (default in `.env.example`) +Laravel is accessible, powerful, and provides tools required for large, robust applications. -## Local Setup +## Learning Laravel -1. Install dependencies: +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. - ```bash - composer install - npm install - ``` +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. -2. Configure environment: +## Laravel Sponsors - ```bash - cp .env.example .env - php artisan key:generate - ``` +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). -3. Update database and OAuth values in `.env` (minimum: DB_*). +### Premium Partners -4. Run migrations and seeders: +- **[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/services/technologies/laravel/)** +- **[OP.GG](https://op.gg)** - ```bash - php artisan migrate --seed - ``` +## Contributing -5. Start the app and asset pipeline: +Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions). - ```bash - php artisan serve - npm run dev - ``` +## Code of Conduct -6. If using an async queue connection for imports, run a worker: +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). - ```bash - php artisan queue:work - ``` +## Security Vulnerabilities -## Useful Commands - -- Run tests: `php artisan test` -- Build production assets: `npm run prod` -- Create a user: `php artisan user:create ` -- Create an admin user: `php artisan user:create --admin` - -## OAuth (Discord) - -To enable Discord login, set these variables in `.env`: - -- `DISCORD_CLIENT_ID` -- `DISCORD_CLIENT_SECRET` -- `DISCORD_REDIRECT_URI` - -The callback route is `/oauth/discord/callback`. +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 -This project is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT). +The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).