https://github.com/atomjoy/webi-mini
Laravel rest api authentication with csrf and session cookies without roles.
https://github.com/atomjoy/webi-mini
laravel-auth laravel-authentication
Last synced: 2 months ago
JSON representation
Laravel rest api authentication with csrf and session cookies without roles.
- Host: GitHub
- URL: https://github.com/atomjoy/webi-mini
- Owner: atomjoy
- Created: 2023-03-05T12:05:13.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-05T12:09:31.000Z (about 2 years ago)
- Last Synced: 2025-01-07T18:53:42.125Z (4 months ago)
- Language: PHP
- Homepage: https://github.com/atomjoy/webi-mini
- Size: 55.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Webi auth library
Laravel rest api authentication.
## Install (Laravel 10, Php 8.1)
First set your .env variables (mysql, smtp) and then
```sh
composer require atomjoy/webi-mini
```
## User model
```php
// app/Models/User.php
mergeFillable([
// 'mobile', 'website'
]);
$this->mergeCasts([
// 'role' => UserRole::class,
// 'status' => StatusEnum::class,
// 'email_verified_at' => 'datetime:Y-m-d H:i:s',
]);
// $this->hidden[] = 'secret_hash';
}
protected $dispatchesEvents = [
// 'saved' => UserSaved::class,
// 'deleted' => UserDeleted::class,
];
}
```
## Create login page
```php
// routes/web.php
Route::get('/login', function() {
return 'My login page'; // return view('vue');
})->name('login');
```
## Create activation page
```php
// routes/web.php
use Webi\Http\Controllers\WebiActivate;
// Create your own activation page for Vue, Laravel
Route::get('/activate/{id}/{code}', [YourActivationController::class, 'index'])->middleware(['webi-locale']);
// Or for tests use json controller from Webi\Http\Controllers\WebiActivate.php
Route::get('/activate/{id}/{code}', [WebiActivate::class, 'index'])->middleware(['webi-locale']);
```
## Copy translations to app lang (for tests only)
```sh
php artisan lang:publish
php artisan vendor:publish --tag=webi-lang-en --force
php artisan vendor:publish --tag=webi-lang-pl --force
```
## Create db tables
```sh
# Create tables
php artisan migrate
# Refresh tables
php artisan migrate:fresh
# Seed data (optional)
php artisan db:seed --class=WebiSeeder
```
## Run application
```sh
php artisan serve
```
## Testing
Tests readme file location
```sh
tests/README.md
```
## Settings (optional)
### Customize
```sh
# Edit email blade themes
php artisan vendor:publish --tag=webi-email
# Edit lang translations
php artisan vendor:publish --tag=webi-lang
# Edit config
php artisan vendor:publish --tag=webi-config
# Override config
php artisan vendor:publish --tag=webi-config --force
# Add the image logo to your mail
php artisan vendor:publish --tag=webi-public
# Provider
php artisan vendor:publish --provider="Webi\WebiServiceProvider.php"
```
## Tables seeder
```sh
php artisan db:seed --class=WebiSeeder
```
## Update classes
```sh
composer update
composer dump-autoload -o
composer update --no-dev
```
## Web API Requests
Send requests as json. Response as json: **{'message', "user"}**. For more go to: **src/Http/Requests** and **src\Http\Controllers** directories or to routes file **routes/web.php**.
### /web/api/login
Method: **POST**
```sh
Params: 'email', 'password', 'remember_me'
Data: {'message', "user"}
```
### /web/api/register
Method: **POST**
```sh
Params: 'name', 'email', 'password', 'password_confirmation'
Data: {'message', 'created'}
```
### /web/api/reset
Method: **POST**
```sh
Params: 'email'
Data: {'message'}
```
### /web/api/activate/{id}/{code}
Method: **GET**
```sh
Params: 'id', 'code'
Data: {'message'}
```
### /web/api/logout
Method: **GET**
```sh
Params: without params
Data: {'message'}
```
### /web/api/locale/{locale}
Method: **GET**
```sh
Params: 'locale'
Data: {'message', 'locale'}
```
### /web/api/csrf
Method: **GET**
```sh
Params: without params
Data: {'message', 'counter', 'locale'}
```
### /web/api/logged
Method: **GET**
```sh
Params: without params
Data: {'message', 'locale', "user"}
```
### /web/api/change-password
Method: **POST** Auth: **true**
```sh
Params: 'password_current', 'password', 'password_confirmation'
Data: {'message'}
```
### /web/api/test/user, /web/api/test/worker, /web/api/test/admin
Method: **GET** Auth: **true**
```sh
Params: without params
Data: {'message', "user", 'ip'}
```