Skip to content

Commit

Permalink
improve the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
alfredobarron authored Oct 18, 2018
1 parent bc09a09 commit b72c6fd
Showing 1 changed file with 21 additions and 8 deletions.
29 changes: 21 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,12 @@ https://medium.com/modulr/create-scaffold-with-laravel-5-7-f5ab353dff1c
git clone https://github.com/modulr/laravel-scaffold.git
```

#### Depencencies
##### Enter folder
```
cd laravel-scaffold
```

#### Install Depencencies
```
composer install
npm install
Expand All @@ -41,6 +45,16 @@ npm install
cp .env.example .env
```

#### Generate APP_KEY
```
php artisan key:generate
```

#### Generate symbolic link to Storage
```
php artisan storage:link
```

#### Database

```
Expand All @@ -60,17 +74,13 @@ DB_PASSWORD=password
```

#### File System

```
# Add params into .env file
APP_URL=http://laravel-scaffold.test
FILESYSTEM_DRIVER=public
```

```
# Generate symbolic link to Storage
php artisan storage:link
```


## Run

Expand Down Expand Up @@ -103,18 +113,20 @@ php artisan serve
- Upload & Restart Avatar


- Users & Roles --> _Comming soon..._

- Users --> _Comming soon..._
- Roles --> _Comming soon..._

## Packages

##### Backend

- [Laravel Authentication](https://laravel.com/docs/5.7/authentication)
- [Laravolt Avatar](https://github.com/laravolt/avatar)
- [Intervention Image](http://image.intervention.io/)


##### Frontend

- [Laravel Frontend](https://laravel.com/docs/5.7/frontend)
- [Bootstrap 4](https://getbootstrap.com/)
- [Core UI](https://coreui.io/)
Expand All @@ -126,6 +138,7 @@ php artisan serve


## License

The MIT© License 2018 - Modulr.

---
Expand Down

0 comments on commit b72c6fd

Please sign in to comment.