From 848129ac981840e315d0d4f1cd08dff8f55006f5 Mon Sep 17 00:00:00 2001 From: Hasin Hayder Date: Sat, 21 May 2022 00:09:47 +0600 Subject: [PATCH] Readme --- README.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 91d9b11..861a8c8 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Hydra +# Hydra - Zero Config API Boilerplate for Laravel Sanctum -Zero config API Boilerplate with roles and abilities for Laravel Sanctum +Zero config API Boilerplate with user and role management API for Laravel Sanctum. ## Getting Started It's super easy to get Hydra up and running. @@ -16,6 +16,12 @@ git clone https://github.com/hasinhayder/hydra.git cp .env.example .env ``` +3. Start the webserver + +```shell +php artisan serve +``` + That's mostly it! You have a fully running laravel installation with Sanctum, all configured. ## Database Migration and Seeding @@ -47,3 +53,14 @@ php artisan db:seed ``` Please note that the default admin user is **admin@hydra.project** and default password is **hydra**. You should create a new admin user before deploying to production and delete this default admin user. You can do that using available Hydra user management API, or using any DB management tool. + +## List of Default Routes + +Here is a list of default routes. Run the following artisan command to see this list in your terminal. + +``` +php artisan route:list +``` + +![Hydra - List of Default Routes](https://i.ibb.co/P629RbT/ezgif-5-78882ff5fc.webp) +