Readme Updated

pull/16/head
Hasin Hayder 2 years ago
parent 9c2ab6ce1c
commit 78d8ebc7de

@ -9,6 +9,8 @@ Hydra is a zero-config API boilerplate with Laravel Sanctum and comes with excel
- [Hydra - Zero Config API Boilerplate with Laravel Sanctum](#hydra---zero-config-api-boilerplate-with-laravel-sanctum)
- [Getting Started](#getting-started)
- [Without Docker](#without-docker)
- [Using Docker & Laravel Sail](#using-docker--laravel-sail)
- [Screencast](#screencast)
- [Database Migration and Seeding](#database-migration-and-seeding)
- [List of Default Routes](#list-of-default-routes)
@ -52,17 +54,12 @@ cd hydra
Then follow the process using either Docker or without Docker.
### Using Docker
### Without Docker
1. install the dependencies
```shell
docker run --rm \
-u "$(id -u):$(id -g)" \
-v $(pwd):/var/www/html \
-w /var/www/html \
laravelsail/php81-composer:latest \
composer install --ignore-platform-reqs
composer install
```
2. Copy `.env.example` to `.env`
@ -71,26 +68,31 @@ docker run --rm \
cp .env.example .env
```
3. Run the containers
3. Generate application key
```shell
./vendor/bin/sail up
php artisan key:generate
```
4. Generate application key
4. Start the webserver
```shell
./vendor/bin/sail artisan key:generate
php artisan serve
```
To learn more about Sail, visit the [official Doc](https://laravel.com/docs/9.x/sail).
That's mostly it! You have a fully running laravel installation with Sanctum, all configured.
### Without Docker
### Using Docker & Laravel Sail
1. install the dependencies
```shell
composer install
docker run --rm \
-u "$(id -u):$(id -g)" \
-v $(pwd):/var/www/html \
-w /var/www/html \
laravelsail/php81-composer:latest \
composer install --ignore-platform-reqs
```
2. Copy `.env.example` to `.env`
@ -99,20 +101,19 @@ composer install
cp .env.example .env
```
3. Generate application key
3. Run the containers
```shell
php artisan key:generate
./vendor/bin/sail up
```
4. Start the webserver
4. Generate application key
```shell
php artisan serve
./vendor/bin/sail artisan key:generate
```
That's mostly it! You have a fully running laravel installation with Sanctum, all configured.
To learn more about Sail, visit the [official Doc](https://laravel.com/docs/9.x/sail).
### Screencast

Loading…
Cancel
Save