Skip to content
This repository was archived by the owner on Feb 18, 2023. It is now read-only.

Commit bc2b898

Browse files
author
joselfonseca
committed
Update readme and delete travis file
1 parent d39ac31 commit bc2b898

File tree

2 files changed

+41
-40
lines changed

2 files changed

+41
-40
lines changed

.travis.yml

Lines changed: 0 additions & 16 deletions
This file was deleted.

readme.md

Lines changed: 41 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
## Laravel API Starter Kit
22

3-
[![Build Status](https://travis-ci.org/joselfonseca/laravel-api.svg)](https://travis-ci.org/joselfonseca/laravel-api)
4-
[![StyleCI](https://styleci.io/repos/52485545/shield?branch=master)](https://styleci.io/repos/52485545)
53
[![Total Downloads](https://poser.pugx.org/joselfonseca/laravel-api/downloads.svg)](https://packagist.org/packages/joselfonseca/laravel-api)
64
[![License](https://poser.pugx.org/laravel/framework/license.svg)](https://packagist.org/packages/laravel/framework)
75

86
Laravel API starter Kit will provide you with the tools for making API's that everyone will love, API Authentication is already provided with passport.
97

108
Here is a list of the packages installed:
119

12-
- [Dingo API](https://github.com/dingo/api)
13-
- [Laravel Passport](https://laravel.com/docs/5.7/passport)
10+
- [Laravel Passport](https://laravel.com/docs/8.x/passport)
11+
- [Laravel Fractal](https://github.com/spatie/laravel-fractal)
1412
- [Laravel Permission](https://github.com/spatie/laravel-permission)
1513
- [Intervention Image](http://image.intervention.io/)
1614

@@ -22,36 +20,58 @@ To install the project you can use composer
2220
composer create-project joselfonseca/laravel-api new-api
2321
```
2422

25-
Then run `composer install` again and the error should be gone.
26-
2723
Modify the .env file to suit your needs
2824

2925
```
26+
APP_NAME=Laravel
3027
APP_ENV=local
28+
APP_KEY=
3129
APP_DEBUG=true
32-
APP_KEY=base64:JqyMTmt5qr1CW6BH+GG+4iKfU4RiNjZTLy33TdTT7+4=
30+
APP_URL=http://localhost
3331
34-
API_STANDARDS_TREE=vnd
35-
API_SUBTYPE=api
36-
API_PREFIX=api
37-
API_VERSION=v1
38-
API_DEBUG=true
32+
LOG_CHANNEL=stack
33+
LOG_LEVEL=debug
3934
40-
DB_HOST=localhost
41-
DB_DATABASE=laravel_api
42-
DB_USERNAME=homestead
43-
DB_PASSWORD=secret
35+
DB_CONNECTION=mysql
36+
DB_HOST=127.0.0.1
37+
DB_PORT=3306
38+
DB_DATABASE=laravel
39+
DB_USERNAME=root
40+
DB_PASSWORD=
4441
42+
BROADCAST_DRIVER=log
4543
CACHE_DRIVER=file
44+
QUEUE_CONNECTION=sync
4645
SESSION_DRIVER=file
47-
QUEUE_DRIVER=sync
46+
SESSION_LIFETIME=120
47+
48+
MEMCACHED_HOST=127.0.0.1
4849
49-
MAIL_DRIVER=smtp
50-
MAIL_HOST=mailtrap.io
51-
MAIL_PORT=2525
50+
REDIS_HOST=127.0.0.1
51+
REDIS_PASSWORD=null
52+
REDIS_PORT=6379
53+
54+
MAIL_MAILER=smtp
55+
MAIL_HOST=mailhog
56+
MAIL_PORT=1025
5257
MAIL_USERNAME=null
5358
MAIL_PASSWORD=null
5459
MAIL_ENCRYPTION=null
60+
MAIL_FROM_ADDRESS=null
61+
MAIL_FROM_NAME="${APP_NAME}"
62+
63+
AWS_ACCESS_KEY_ID=
64+
AWS_SECRET_ACCESS_KEY=
65+
AWS_DEFAULT_REGION=us-east-1
66+
AWS_BUCKET=
67+
68+
PUSHER_APP_ID=
69+
PUSHER_APP_KEY=
70+
PUSHER_APP_SECRET=
71+
PUSHER_APP_CLUSTER=mt1
72+
73+
MIX_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
74+
MIX_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"
5575
```
5676

5777
When you have the .env with your database connection set up you can run your migrations
@@ -61,9 +81,7 @@ php artisan migrate
6181
```
6282
Then run `php artisan passport:install`
6383

64-
Run `php artisan app:install` and fill out the information of the admin user.
65-
66-
You should be done with the basic installation and configuration.
84+
Run `php artisan db:seed` and you should have a new user with the roles and permissions set up
6785

6886
## Tests
6987

@@ -74,7 +92,6 @@ The project uses API blueprint as API spec and [Aglio](https://github.com/daniel
7492
```bash
7593
composer api-docs
7694
```
77-
Also, an OpenAPI spec is given from the blueprint generated documentation in case is needed.
7895

7996
## License
8097

0 commit comments

Comments
 (0)