Skip to content
This repository was archived by the owner on Nov 26, 2024. It is now read-only.

Commit 1daa1e5

Browse files
committed
Update README
1 parent 87f360f commit 1daa1e5

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,35 @@ Create [Google Service Account Credentials](https://console.developers.google.co
5353

5454
## Usage
5555

56+
### User Accounts
57+
58+
By default, there's no users created. But you can run `php artisan db:seed DevelopmentSeeder` to run create 3 main users - Developer, Administrator and User.
59+
60+
Login details for default users:
61+
62+
1. E-mail : **[email protected]** Password: `developer`
63+
2. E-mail : **[email protected]** Password: `administrator`
64+
3. 1. E-mail : **[email protected]** Password: `user`
65+
66+
By default, all newly registered user will be assign role as `user`.
67+
68+
### Access Control
69+
70+
Access control for the application can be configure from `config/acl.php`. It consist of `roles`, `permissions` and `actions`. Default seeder for ACL is in `database/seeds/RolesAndPermissionsSeeder.php`. You may overwrite this as you please.
71+
72+
Seeded roles and permissions based on `database/seeds/RolesAndPermissionsSeeder.php` will have all guards specify in `config/auth.php`.
73+
5674
### Commands
5775

5876
There's some commands area ready built-in. Others, may refer to respective packages.
5977

6078
- `reload:db` - Run `migrate:fresh --seed` with `profile:seed`. You may extend the usage.
6179
- `reload:cache` - Recache everything
80+
- `reload:all` - Run above two commands. Passing `-d` will seed `DevelopementSeeder` - useful for development setup.
81+
82+
### API
83+
84+
This boilerplate make use of Laravel Passport. Managing passport only allowed in for role developer. You can overwrite this behaviour in `routes/web.php`.
6285

6386
### Helpers
6487

@@ -192,6 +215,10 @@ Simply record audit trail on given `$model`, with proper `$message`. You can opt
192215
]
193216
```
194217

218+
**user()**
219+
220+
The `user()` helper simply return the current logged in user object. The helper will take care your guard.
221+
195222
## Test
196223

197224
To run the test, type `vendor/bin/phpunit` in your terminal.

0 commit comments

Comments
 (0)