.env.example
APP_NAME="Laravel Realworld Example App"
APP_ENV=local
APP_KEY=
APP_DEBUG=true
APP_URL=http://localhost
APP_PORT=3000
LOG_CHANNEL=stack
LOG_DEPRECATIONS_CHANNEL=null
LOG_LEVEL=debug
DB_CONNECTION=pgsql
DB_HOST=pgsql
DB_PORT=5432
DB_DATABASE=laravel-realworld
DB_USERNAME=sail
DB_PASSWORD=password
BROADCAST_DRIVER=log
CACHE_DRIVER=file
FILESYSTEM_DISK=local
QUEUE_CONNECTION=sync
SESSION_DRIVER=file
SESSION_LIFETIME=120
MEMCACHED_HOST=127.0.0.1
REDIS_HOST=127.0.0.1
REDIS_PASSWORD=null
REDIS_PORT=6379
MAIL_MAILER=smtp
MAIL_HOST=mailhog
MAIL_PORT=1025
MAIL_USERNAME=null
MAIL_PASSWORD=null
MAIL_ENCRYPTION=null
MAIL_FROM_ADDRESS="hello@example.com"
MAIL_FROM_NAME="${APP_NAME}"
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_DEFAULT_REGION=us-east-1
AWS_BUCKET=
AWS_USE_PATH_STYLE_ENDPOINT=false
PUSHER_APP_ID=
PUSHER_APP_KEY=
PUSHER_APP_SECRET=
PUSHER_APP_CLUSTER=mt1
MIX_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
MIX_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"
L5_SWAGGER_GENERATE_ALWAYS=true
SAIL_XDEBUG_MODE=develop,debug
SAIL_SKIP_CHECKS=true
.gitignore
/node_modules
/public/hot
/public/storage
/storage/*.key
/vendor
.env
.env.backup
.phpunit.result.cache
Homestead.json
Homestead.yaml
npm-debug.log
yarn-error.log
/.idea
/.vscode
/.phpstorm.meta.php
/_ide_helper.php
/_ide_helper_models.php
/coverage.xml
README.md
# 
[](https://github.com/gothinkster/realworld)
[](https://github.com/f1amy/laravel-realworld-example-app/actions/workflows/tests.yml)
[](https://codecov.io/gh/f1amy/laravel-realworld-example-app)
[](https://github.com/f1amy/laravel-realworld-example-app/actions/workflows/static-analysis.yml)
[](https://opensource.org/licenses/MIT)
> Example of a PHP-based Laravel application containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the [RealWorld](https://github.com/gothinkster/realworld) API spec.
This codebase was created to demonstrate a backend application built with [Laravel framework](https://laravel.com/) including RESTful services, CRUD operations, authentication, routing, pagination, and more.
We've gone to great lengths to adhere to the **Laravel framework** community style guides & best practices.
For more information on how to this works with other frontends/backends, head over to the [RealWorld](https://github.com/gothinkster/realworld) repo.
## How it works
The API is built with [Laravel](https://laravel.com/), making the most of the framework's features out-of-the-box.
The application is using a custom JWT auth implementation: [`app/Jwt`](./app/Jwt).
## Getting started
The preferred way of setting up the project is using [Laravel Sail](https://laravel.com/docs/sail),
for that you'll need [Docker](https://docs.docker.com/get-docker/) under Linux / macOS (or Windows WSL2).
### Installation
Clone the repository and change directory:
git clone https://github.com/f1amy/laravel-realworld-example-app.git
cd laravel-realworld-example-app
Install dependencies (if you have `composer` locally):
composer create-project
Alternatively you can do the same with Docker:
docker run --rm -it \
--volume $PWD:/app \
--user $(id -u):$(id -g) \
composer create-project
Start the containers with PHP application and PostgreSQL database:
./vendor/bin/sail up -d
(Optional) Configure a Bash alias for `sail` command:
alias sail='[ -f sail ] && bash sail || bash vendor/bin/sail'
Migrate the database with seeding:
sail artisan migrate --seed
## Usage
The API is available at `http://localhost:3000/api` (You can change the `APP_PORT` in `.env` file).
### Run tests
sail artisan test
### Run PHPStan static analysis
sail php ./vendor/bin/phpstan
### OpenAPI specification (not ready yet)
Swagger UI will be live at [http://localhost:3000/api/documentation](http://localhost:3000/api/documentation).
For now, please visit the specification [here](https://github.com/gothinkster/realworld/tree/main/api).
## Contributions
Feedback, suggestions, and improvements are welcome, feel free to contribute.
## License
The MIT License (MIT). Please see [`LICENSE`](./LICENSE) for more information.
app
+---- Auth
| +---- JwtGuard.php
<?php
namespace App\Auth;
use App\Contracts\JwtTokenInterface;
use App\Exceptions\JwtParseException;
use App\Jwt;
use Illuminate\Auth\GuardHelpers;
use Illuminate\Contracts\Auth\Guard;
use Illuminate\Contracts\Auth\UserProvider;
use Illuminate\Http\Request;
use Illuminate\Support\Str;
use JsonException;
/**
* Class JwtGuard
*
* @package App\Auth
* @property \Illuminate\Contracts\Auth\Authenticatable|null $user
*/
class JwtGuard implements Guard
{
use GuardHelpers;
/**
* The request instance.
*/
protected Request $request;
/**
* The name of the query string item from the request containing the API token.
*/
protected string $inputKey;
/**
* Create a new authentication guard.
*
* @param \Illuminate\Contracts\Auth\UserProvider $provider
* @param \Illuminate\Http\Request $request
* @param string $inputKey
* @return void
*/
public function __construct(
UserProvider $provider,
Request $request,
string $inputKey = 'token')
{
$this->request = $request;
$this->provider = $provider;
$this->inputKey = $inputKey;
}
/**
* Get the currently authenticated user.
*
* @return \Illuminate\Contracts\Auth\Authenticatable|null
*/
public function user()
{
// If we've already retrieved the user for the current request we can just
// return it back immediately. We do not want to fetch the user data on
// every call to this method because that would be tremendously slow.
if (! is_null($this->user)) {
return $this->user;
}
$user = null;
$token = $this->getTokenForRequest();
if (! empty($token) && is_string($token)) {
try {
$jwt = Jwt\Parser::parse($token);
} catch (JwtParseException | JsonException) {
$jwt = null;
}
if ($this->validate([$this->inputKey => $jwt])) {
/** @var \App\Contracts\JwtTokenInterface $jwt */
$user = $this->provider->retrieveById(
$jwt->getSubject()
);
}
}
return $this->user = $user;
}
/**
* Validate a user's credentials.
*
* @param array<string, mixed> $credentials
* @return bool
*/
public function validate(array $credentials = [])
{
if (empty($credentials[$this->inputKey])) {
return false;
}
$token = $credentials[$this->inputKey];
if (! $token instanceof JwtTokenInterface) {
return false;
}
return Jwt\Validator::validate($token);
}
/**
* Get the token for the current request.
*
* @return mixed|null
*/
public function getTokenForRequest()
{
$token = $this->jwtToken();
if (empty($token)) {
$token = $this->request->query($this->inputKey);
}
if (empty($token)) {
$token = $this->request->input($this->inputKey);
}
return $token;
}
/**
* Get the JWT token from the request headers.
*
* @return string|null
*/
public function jwtToken(): ?string
{
/** @var string $header */
$header = $this->request->header('Authorization', '');
if (Str::startsWith($header, 'Token ')) {
return Str::substr($header, 6);
}
return null;
}
}
+---- Console
| +---- Kernel.php
<?php
namespace App\Console;
use Illuminate\Console\Scheduling\Schedule;
use Illuminate\Foundation\Console\Kernel as ConsoleKernel;
/**
* @codeCoverageIgnore
*/
class Kernel extends ConsoleKernel
{
/**
* Define the application's command schedule.
*
* @param \Illuminate\Console\Scheduling\Schedule $schedule
* @return void
*/
protected function schedule(Schedule $schedule)
{
// $schedule->command('inspire')->hourly();
}
/**
* Register the commands for the application.
*
* @return void
*/
protected function commands()
{
$this->load(__DIR__.'/Commands');
require base_path('routes/console.php');
}
}
+---- Contracts
| +---- JwtBuilderInterface.php
<?php
namespace App\Contracts;
interface JwtBuilderInterface
{
/**
* Start building JwtToken.
*
* @return \App\Contracts\JwtBuilderInterface
*/
public static function build(): JwtBuilderInterface;
/**
* Add issued at (iat) claim to the payload.
*
* @param int $timestamp
* @return \App\Contracts\JwtBuilderInterface
*/
public function issuedAt(int $timestamp): JwtBuilderInterface;
/**
* Add expires at (exp) claim to the payload.
*
* @param int $timestamp
* @return \App\Contracts\JwtBuilderInterface
*/
public function expiresAt(int $timestamp): JwtBuilderInterface;
/**
* Add subject (sub) claim to the payload.
*
* @param JwtSubjectInterface|mixed $identifier
* @return \App\Contracts\JwtBuilderInterface
*/
public function subject(mixed $identifier): JwtBuilderInterface;
/**
* Add custom claim to the payload.
*
* @param string $key
* @param mixed|null $value
* @return \App\Contracts\JwtBuilderInterface
*/
public function withClaim(string $key, mixed $value = null): JwtBuilderInterface;
/**
* Add custom header.
*
* @param string $key
* @param mixed|null $value
* @return \App\Contracts\JwtBuilderInterface
*/
public function withHeader(string $key, mixed $value = null): JwtBuilderInterface;
/**
* Get JwtToken built.
*
* @return \App\Contracts\JwtTokenInterface
*/
public function getToken(): JwtTokenInterface;
}
| +---- JwtGeneratorInterface.php
<?php
namespace App\Contracts;
interface JwtGeneratorInterface
{
/**
* Generate JWT signature.
*
* @param \App\Contracts\JwtTokenInterface $token
* @return string
*/
public static function signature(JwtTokenInterface $token): string;
/**
* Generate JWT string.
*
* @param \App\Contracts\JwtSubjectInterface $user
* @return string
*/
public static function token(JwtSubjectInterface $user): string;
}
| +---- JwtParserInterface.php
<?php
namespace App\Contracts;
interface JwtParserInterface
{
/**
* Parse JWT and return JwtToken instance.
* Use JwtValidator to verify the token.
*
* @param string $token
* @return \App\Contracts\JwtTokenInterface
* @see \App\Contracts\JwtValidatorInterface::validate()
*/
public static function parse(string $token): JwtTokenInterface;
}
| +---- JwtSubjectInterface.php
<?php
namespace App\Contracts;
interface JwtSubjectInterface
{
/**
* Get JWT subject identifier (User Key).
*
* @return mixed
*/
public function getJwtIdentifier(): mixed;
}
| +---- JwtTokenInterface.php
<?php
namespace App\Contracts;
use Illuminate\Support\Collection;
interface JwtTokenInterface
{
/**
* Get default headers.
*
* @return array<string>
*/
public function getDefaultHeaders(): array;
/**
* Get a copy of headers set on token.
*
* @return \Illuminate\Support\Collection<string, mixed>
*/
public function headers(): Collection;
/**
* Get a copy of claims set on token.
*
* @return \Illuminate\Support\Collection<string, mixed>
*/
public function claims(): Collection;
/**
* Get saved user-supplied signature.
*
* @return string|null
*/
public function getUserSignature(): ?string;
/**
* Put value to payload under a key.
*
* @param string $key
* @param mixed $value
*/
public function putToPayload(string $key, mixed $value): void;
/**
* Put value to header under a key.
*
* @param string $key
* @param mixed $value
*/
public function putToHeader(string $key, mixed $value): void;
/**
* Set user-supplied signature.
*
* @param string $signature
*/
public function setUserSignature(string $signature): void;
/**
* Get subject key.
*
* @return mixed
*/
public function getSubject(): mixed;
/**
* Get expiration timestamp.
*
* @return int
*/
public function getExpiration(): int;
}
| +---- JwtValidatorInterface.php
<?php
namespace App\Contracts;
interface JwtValidatorInterface
{
/**
* Validate JwtToken signature, header, expiration and subject.
*
* @param \App\Contracts\JwtTokenInterface $token
* @return bool
*/
public static function validate(JwtTokenInterface $token): bool;
}
+---- Exceptions
| +---- Handler.php
<?php
namespace App\Exceptions;
use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use Throwable;
/**
* @codeCoverageIgnore
*/
class Handler extends ExceptionHandler
{
/**
* A list of the exception types that are not reported.
*
* @var array<int, class-string<Throwable>>
*/
protected $dontReport = [
//
];
/**
* A list of the inputs that are never flashed for validation exceptions.
*
* @var array<int, string>
*/
protected $dontFlash = [
'current_password',
'password',
'password_confirmation',
];
/**
* Register the exception handling callbacks for the application.
*
* @return void
*/
public function register()
{
$this->renderable(function (NotFoundHttpException $e) {
if ($e->getPrevious() instanceof ModelNotFoundException) {
return response()->json([
'message' => trans('models.resource.404'),
], 404);
}
return null;
});
}
}
| +---- JwtParseException.php
<?php
namespace App\Exceptions;
use Exception;
class JwtParseException extends Exception
{
//
}
+---- Http
| +---- Controllers
| +---- Api
| +---- Articles
| +---- ArticleController.php
<?php
namespace App\Http\Controllers\Api\Articles;
use App\Http\Controllers\Controller;
use App\Http\Requests\Api\ArticleListRequest;
use App\Http\Requests\Api\FeedRequest;
use App\Http\Requests\Api\NewArticleRequest;
use App\Http\Requests\Api\UpdateArticleRequest;
use App\Http\Resources\Api\ArticleResource;
use App\Http\Resources\Api\ArticlesCollection;
use App\Models\Article;
use Illuminate\Support\Arr;
use Illuminate\Support\Collection;
class ArticleController extends Controller
{
/** @var int Default limit for feed listing. */
protected const FILTER_LIMIT = 20;
/** @var int Default offset for feed listing. */
protected const FILTER_OFFSET = 0;
/**
* Display global listing of the articles.
*
* @param \App\Http\Requests\Api\ArticleListRequest $request
* @return \App\Http\Resources\Api\ArticlesCollection<Article>
*/
public function list(ArticleListRequest $request)
{
$filter = collect($request->validated());
$limit = $this->getLimit($filter);
$offset = $this->getOffset($filter);
$list = Article::list($limit, $offset);
if ($tag = $filter->get('tag')) {
$list->havingTag($tag);
}
if ($authorName = $filter->get('author')) {
$list->ofAuthor($authorName);
}
if ($userName = $filter->get('favorited')) {
$list->favoredByUser($userName);
}
return new ArticlesCollection($list->get());
}
/**
* Display article feed for the user.
*
* @param \App\Http\Requests\Api\FeedRequest $request
* @return \App\Http\Resources\Api\ArticlesCollection<Article>
*/
public function feed(FeedRequest $request)
{
$filter = collect($request->validated());
$limit = $this->getLimit($filter);
$offset = $this->getOffset($filter);
$feed = Article::list($limit, $offset)
->followedAuthorsOf($request->user());
return new ArticlesCollection($feed->get());
}
/**
* Store a newly created resource in storage.
*
* @param \App\Http\Requests\Api\NewArticleRequest $request
* @return \Illuminate\Http\JsonResponse
*/
public function create(NewArticleRequest $request)
{
/** @var \App\Models\User $user */
$user = $request->user();
$attributes = $request->validated();
$attributes['author_id'] = $user->getKey();
$tags = Arr::pull($attributes, 'tagList');
$article = Article::create($attributes);
if (is_array($tags)) {
$article->attachTags($tags);
}
return (new ArticleResource($article))
->response()
->setStatusCode(201);
}
/**
* Display the specified resource.
*
* @param string $slug
* @return \App\Http\Resources\Api\ArticleResource
*/
public function show(string $slug)
{
$article = Article::whereSlug($slug)
->firstOrFail();
return new ArticleResource($article);
}
/**
* Update the specified resource in storage.
*
* @param \App\Http\Requests\Api\UpdateArticleRequest $request
* @param string $slug
* @return \App\Http\Resources\Api\ArticleResource
* @throws \Illuminate\Auth\Access\AuthorizationException
*/
public function update(UpdateArticleRequest $request, string $slug)
{
$article = Article::whereSlug($slug)
->firstOrFail();
$this->authorize('update', $article);
$article->update($request->validated());
return new ArticleResource($article);
}
/**
* Remove the specified resource from storage.
*
* @param string $slug
* @return \Illuminate\Http\JsonResponse
* @throws \Illuminate\Auth\Access\AuthorizationException
*/
public function delete(string $slug)
{
$article = Article::whereSlug($slug)
->firstOrFail();
$this->authorize('delete', $article);
$article->delete(); // cascade
return response()->json([
'message' => trans('models.article.deleted'),
]);
}
/**
* Get limit from filter.
*
* @param \Illuminate\Support\Collection<string, string> $filter
* @return int
*/
private function getLimit(Collection $filter): int
{
return (int) ($filter['limit'] ?? static::FILTER_LIMIT);
}
/**
* Get offset from filter.
*
* @param \Illuminate\Support\Collection<string, string> $filter
* @return int
*/
private function getOffset(Collection $filter): int
{
return (int) ($filter['offset'] ?? static::FILTER_OFFSET);
}
}
| +---- CommentsController.php
<?php
namespace App\Http\Controllers\Api\Articles;
use App\Http\Controllers\Controller;
use App\Http\Requests\Api\NewCommentRequest;
use App\Http\Resources\Api\CommentResource;
use App\Http\Resources\Api\CommentsCollection;
use App\Models\Article;
use App\Models\Comment;
class CommentsController extends Controller
{
/**
* Display a listing of the resource.
*
* @param string $slug
* @return \App\Http\Resources\Api\CommentsCollection<Comment>
*/
public function list(string $slug)
{
$article = Article::whereSlug($slug)
->firstOrFail();
return new CommentsCollection($article->comments);
}
/**
* Store a newly created resource in storage.
*
* @param \App\Http\Requests\Api\NewCommentRequest $request
* @param string $slug
* @return \Illuminate\Http\JsonResponse
*/
public function create(NewCommentRequest $request, string $slug)
{
$article = Article::whereSlug($slug)
->firstOrFail();
/** @var \App\Models\User $user */
$user = $request->user();
$comment = Comment::create([
'article_id' => $article->getKey(),
'author_id' => $user->getKey(),
'body' => $request->input('comment.body'),
]);
return (new CommentResource($comment))
->response()
->setStatusCode(201);
}
/**
* Remove the specified resource from storage.
*
* @param string $slug
* @param mixed $id
* @return \Illuminate\Http\JsonResponse
* @throws \Illuminate\Auth\Access\AuthorizationException
*/
public function delete(string $slug, $id)
{
$article = Article::whereSlug($slug)
->firstOrFail();
$comment = $article->comments()
->findOrFail((int) $id);
$this->authorize('delete', $comment);
$comment->delete();
return response()->json([
'message' => trans('models.comment.deleted'),
]);
}
}
| +---- FavoritesController.php
<?php
namespace App\Http\Controllers\Api\Articles;
use App\Http\Controllers\Controller;
use App\Http\Resources\Api\ArticleResource;
use App\Models\Article;
use Illuminate\Http\Request;
class FavoritesController extends Controller
{
/**
* Add article to user's favorites.
*
* @param \Illuminate\Http\Request $request
* @param string $slug
* @return \App\Http\Resources\Api\ArticleResource
*/
public function add(Request $request, string $slug)
{
$article = Article::whereSlug($slug)
->firstOrFail();
/** @var \App\Models\User $user */
$user = $request->user();
$user->favorites()->syncWithoutDetaching($article);
return new ArticleResource($article);
}
/**
* Remove article from user's favorites.
*
* @param \Illuminate\Http\Request $request
* @param string $slug
* @return \App\Http\Resources\Api\ArticleResource
*/
public function remove(Request $request, string $slug)
{
$article = Article::whereSlug($slug)
->firstOrFail();
/** @var \App\Models\User $user */
$user = $request->user();
$user->favorites()->detach($article);
return new ArticleResource($article);
}
}
| +---- AuthController.php
<?php
namespace App\Http\Controllers\Api;
use App\Http\Controllers\Controller;
use App\Http\Requests\Api\LoginRequest;
use App\Http\Requests\Api\NewUserRequest;
use App\Http\Resources\Api\UserResource;
use App\Models\User;
use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\Hash;
class AuthController extends Controller
{
/**
* Register new user.
*
* @param NewUserRequest $request
* @return \Illuminate\Http\JsonResponse
*/
public function register(NewUserRequest $request)
{
$attributes = $request->validated();
$attributes['password'] = Hash::make($attributes['password']);
$user = User::create($attributes);
return (new UserResource($user))
->response()
->setStatusCode(201);
}
/**
* Login existing user.
*
* @param \App\Http\Requests\Api\LoginRequest $request
* @return \App\Http\Resources\Api\UserResource|\Illuminate\Http\JsonResponse
*/
public function login(LoginRequest $request)
{
Auth::shouldUse('web');
if (Auth::attempt($request->validated())) {
return new UserResource(Auth::user());
}
return response()->json([
'message' => trans('validation.invalid'),
'errors' => [
'user' => [trans('auth.failed')],
],
], 422);
}
}
| +---- ProfileController.php
<?php
namespace App\Http\Controllers\Api;
use App\Http\Controllers\Controller;
use App\Http\Resources\Api\ProfileResource;
use App\Models\User;
use Illuminate\Http\Request;
class ProfileController extends Controller
{
/**
* Display the specified resource.
*
* @param string $username
* @return \App\Http\Resources\Api\ProfileResource
*/
public function show(string $username)
{
$profile = User::whereUsername($username)
->firstOrFail();
return new ProfileResource($profile);
}
/**
* Follow an author.
*
* @param \Illuminate\Http\Request $request
* @param string $username
* @return \App\Http\Resources\Api\ProfileResource
*/
public function follow(Request $request, string $username)
{
$profile = User::whereUsername($username)
->firstOrFail();
$profile->followers()
->syncWithoutDetaching($request->user());
return new ProfileResource($profile);
}
/**
* Unfollow an author.
*
* @param \Illuminate\Http\Request $request
* @param string $username
* @return \App\Http\Resources\Api\ProfileResource
*/
public function unfollow(Request $request, string $username)
{
$profile = User::whereUsername($username)
->firstOrFail();
$profile->followers()->detach($request->user());
return new ProfileResource($profile);
}
}
| +---- TagsController.php
<?php
namespace App\Http\Controllers\Api;
use App\Http\Controllers\Controller;
use App\Http\Resources\Api\TagsCollection;
use App\Models\Tag;
class TagsController extends Controller
{
/**
* Display a listing of the resource.
*
* @return \App\Http\Resources\Api\TagsCollection<Tag>
*/
public function list()
{
return new TagsCollection(Tag::all());
}
}
| +---- UserController.php
<?php
namespace App\Http\Controllers\Api;
use App\Http\Controllers\Controller;
use App\Http\Requests\Api\UpdateUserRequest;
use App\Http\Resources\Api\UserResource;
use Illuminate\Http\Request;
class UserController extends Controller
{
/**
* Display the specified resource.
*
* @return \App\Http\Resources\Api\UserResource
*/
public function show(Request $request)
{
return new UserResource($request->user());
}
/**
* Update the specified resource in storage.
*
* @param \App\Http\Requests\Api\UpdateUserRequest $request
* @return \App\Http\Resources\Api\UserResource|\Illuminate\Http\JsonResponse
*/
public function update(UpdateUserRequest $request)
{
if (empty($attrs = $request->validated())) {
return response()->json([
'message' => trans('validation.invalid'),
'errors' => [
'any' => [trans('validation.required_at_least_one')],
],
], 422);
}
/** @var \App\Models\User $user */
$user = $request->user();
$user->update($attrs);
return new UserResource($user);
}
}
| +---- Controller.php
<?php
namespace App\Http\Controllers;
use Illuminate\Foundation\Auth\Access\AuthorizesRequests;
use Illuminate\Foundation\Bus\DispatchesJobs;
use Illuminate\Foundation\Validation\ValidatesRequests;
use Illuminate\Routing\Controller as BaseController;
class Controller extends BaseController
{
use AuthorizesRequests, DispatchesJobs, ValidatesRequests;
}
| +---- Kernel.php
<?php
namespace App\Http;
use Illuminate\Foundation\Http\Kernel as HttpKernel;
class Kernel extends HttpKernel
{
/**
* The application's global HTTP middleware stack.
*
* These middleware are run during every request to your application.
*
* @var array<int, class-string|string>
*/
protected $middleware = [
// \App\Http\Middleware\TrustHosts::class,
\App\Http\Middleware\TrustProxies::class,
\Illuminate\Http\Middleware\HandleCors::class,
\App\Http\Middleware\PreventRequestsDuringMaintenance::class,
\Illuminate\Foundation\Http\Middleware\ValidatePostSize::class,
\App\Http\Middleware\TrimStrings::class,
\Illuminate\Foundation\Http\Middleware\ConvertEmptyStringsToNull::class,
];
/**
* The application's route middleware groups.
*
* @var array<string, array<int, class-string|string>>
*/
protected $middlewareGroups = [
'web' => [
\App\Http\Middleware\EncryptCookies::class,
\Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class,
\Illuminate\Session\Middleware\StartSession::class,
\Illuminate\View\Middleware\ShareErrorsFromSession::class,
\App\Http\Middleware\VerifyCsrfToken::class,
\Illuminate\Routing\Middleware\SubstituteBindings::class,
],
'api' => [
// \Laravel\Sanctum\Http\Middleware\EnsureFrontendRequestsAreStateful::class,
'throttle:api',
\Illuminate\Routing\Middleware\SubstituteBindings::class,
],
];
/**
* The application's route middleware.
*
* These middleware may be assigned to groups or used individually.
*
* @var array<string, class-string|string>
*/
protected $routeMiddleware = [
'auth' => \App\Http\Middleware\Authenticate::class,
'auth.basic' => \Illuminate\Auth\Middleware\AuthenticateWithBasicAuth::class,
'auth.session' => \Illuminate\Session\Middleware\AuthenticateSession::class,
'cache.headers' => \Illuminate\Http\Middleware\SetCacheHeaders::class,
'can' => \Illuminate\Auth\Middleware\Authorize::class,
'guest' => \App\Http\Middleware\RedirectIfAuthenticated::class,
'password.confirm' => \Illuminate\Auth\Middleware\RequirePassword::class,
'signed' => \Illuminate\Routing\Middleware\ValidateSignature::class,
'throttle' => \Illuminate\Routing\Middleware\ThrottleRequests::class,
'verified' => \Illuminate\Auth\Middleware\EnsureEmailIsVerified::class,
];
}
| +---- Middleware
| +---- Authenticate.php
<?php
namespace App\Http\Middleware;
use Illuminate\Auth\Middleware\Authenticate as Middleware;
class Authenticate extends Middleware
{
/**
* Get the path the user should be redirected to when they are not authenticated.
*
* @param \Illuminate\Http\Request $request
* @return string|null
*/
protected function redirectTo($request)
{
if (! $request->expectsJson()) {
return route('login');
}
return null;
}
}
| +---- EncryptCookies.php
<?php
namespace App\Http\Middleware;
use Illuminate\Cookie\Middleware\EncryptCookies as Middleware;
class EncryptCookies extends Middleware
{
/**
* The names of the cookies that should not be encrypted.
*
* @var array<int, string>
*/
protected $except = [
//
];
}
| +---- PreventRequestsDuringMaintenance.php
<?php
namespace App\Http\Middleware;
use Illuminate\Foundation\Http\Middleware\PreventRequestsDuringMaintenance as Middleware;
class PreventRequestsDuringMaintenance extends Middleware
{
/**
* The URIs that should be reachable while maintenance mode is enabled.
*
* @var array<int, string>
*/
protected $except = [
//
];
}
| +---- RedirectIfAuthenticated.php
<?php
namespace App\Http\Middleware;
use App\Providers\RouteServiceProvider;
use Closure;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;
class RedirectIfAuthenticated
{
/**
* Handle an incoming request.
*
* @param \Illuminate\Http\Request $request
* @param \Closure(\Illuminate\Http\Request): (\Illuminate\Http\Response|\Illuminate\Http\RedirectResponse) $next
* @param string|null ...$guards
* @return \Illuminate\Http\Response|\Illuminate\Http\RedirectResponse
*/
public function handle(Request $request, Closure $next, ...$guards)
{
$guards = empty($guards) ? [null] : $guards;
foreach ($guards as $guard) {
if (Auth::guard($guard)->check()) {
return redirect(RouteServiceProvider::HOME);
}
}
return $next($request);
}
}
| +---- TrimStrings.php
<?php
namespace App\Http\Middleware;
use Illuminate\Foundation\Http\Middleware\TrimStrings as Middleware;
class TrimStrings extends Middleware
{
/**
* The names of the attributes that should not be trimmed.
*
* @var array<int, string>
*/
protected $except = [
'current_password',
'password',
'password_confirmation',
];
}
| +---- TrustHosts.php
<?php
namespace App\Http\Middleware;
use Illuminate\Http\Middleware\TrustHosts as Middleware;
class TrustHosts extends Middleware
{
/**
* Get the host patterns that should be trusted.
*
* @return array<int, string|null>
*/
public function hosts()
{
return [
$this->allSubdomainsOfApplicationUrl(),
];
}
}
| +---- TrustProxies.php
<?php
namespace App\Http\Middleware;
use Illuminate\Http\Middleware\TrustProxies as Middleware;
use Illuminate\Http\Request;
class TrustProxies extends Middleware
{
/**
* The trusted proxies for this application.
*
* @var array<int, string>|string|null
*/
protected $proxies;
/**
* The headers that should be used to detect proxies.
*
* @var int
*/
protected $headers =
Request::HEADER_X_FORWARDED_FOR |
Request::HEADER_X_FORWARDED_HOST |
Request::HEADER_X_FORWARDED_PORT |
Request::HEADER_X_FORWARDED_PROTO |
Request::HEADER_X_FORWARDED_AWS_ELB;
}
| +---- VerifyCsrfToken.php
<?php
namespace App\Http\Middleware;
use Illuminate\Foundation\Http\Middleware\VerifyCsrfToken as Middleware;
class VerifyCsrfToken extends Middleware
{
/**
* The URIs that should be excluded from CSRF verification.
*
* @var array<int, string>
*/
protected $except = [
//
];
}
| +---- Requests
| +---- Api
| +---- ArticleListRequest.php
<?php
namespace App\Http\Requests\Api;
class ArticleListRequest extends FeedRequest
{
/**
* Get the validation rules that apply to the request.
*
* @return array<string, mixed>
*/
public function rules()
{
return array_merge(parent::rules(), [
'tag' => 'sometimes|string',
'author' => 'sometimes|string',
'favorited' => 'sometimes|string',
]);
}
}
| +---- BaseArticleRequest.php
<?php
namespace App\Http\Requests\Api;
use App\Models\Article;
use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Support\Arr;
use Illuminate\Support\Str;
use Illuminate\Validation\Rule;
abstract class BaseArticleRequest extends FormRequest
{
/**
* Prepare the data for validation.
*
* @return void
*/
protected function prepareForValidation()
{
$input = $this->input();
$title = Arr::get($input, 'article.title');
if (is_string($title)) {
Arr::set($input, 'article.slug', Str::slug($title));
} else {
Arr::forget($input, 'article.slug');
}
$this->merge($input);
}
/**
* Get the validation rules that apply to the request.
*
* @return array<string, mixed>
*/
public function rules()
{
$article = Article::whereSlug($this->route('slug'))
->first();
$unique = Rule::unique('articles', 'slug');
if ($article !== null) {
$unique->ignoreModel($article);
}
return [
'title' => ['string', 'max:255'],
'slug' => ['string', 'max:255', $unique],
'description' => ['string', 'max:510'],
'body' => ['string'],
];
}
/**
* @return array<mixed>
*/
public function validationData()
{
return Arr::wrap($this->input('article'));
}
}
| +---- FeedRequest.php
<?php
namespace App\Http\Requests\Api;
use Illuminate\Foundation\Http\FormRequest;
class FeedRequest extends FormRequest
{
/**
* Get the validation rules that apply to the request.
*
* @return array<string, mixed>
*/
public function rules()
{
return [
'limit' => 'sometimes|integer|min:0',
'offset' => 'sometimes|integer|min:0',
];
}
}
| +---- LoginRequest.php
<?php
namespace App\Http\Requests\Api;
use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Support\Arr;
class LoginRequest extends FormRequest
{
/**
* Get the validation rules that apply to the request.
*
* @return array<string, mixed>
*/
public function rules()
{
return [
'email' => 'required|string|email',
'password' => 'required|string',
];
}
/**
* @return array<mixed>
*/
public function validationData()
{
return Arr::wrap($this->input('user'));
}
}
| +---- NewArticleRequest.php
<?php
namespace App\Http\Requests\Api;
class NewArticleRequest extends BaseArticleRequest
{
public function rules()
{
return array_merge_recursive(parent::rules(), [
'title' => ['required'],
'slug' => ['required'],
'description' => ['required'],
'body' => ['required'],
'tagList' => 'sometimes|array',
'tagList.*' => 'required|string|max:255',
]);
}
}
| +---- NewCommentRequest.php
<?php
namespace App\Http\Requests\Api;
use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Support\Arr;
class NewCommentRequest extends FormRequest
{
/**
* Get the validation rules that apply to the request.
*
* @return array<string, mixed>
*/
public function rules()
{
return [
'body' => 'required|string',
];
}
/**
* @return array<mixed>
*/
public function validationData()
{
return Arr::wrap($this->input('comment'));
}
}
| +---- NewUserRequest.php
<?php
namespace App\Http\Requests\Api;
use App\Models\User;
use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Support\Arr;
use Illuminate\Validation\Rules\Password;
class NewUserRequest extends FormRequest
{
/**
* Get the validation rules that apply to the request.
*
* @return array<string, mixed>
*/
public function rules()
{
return [
'username' => [
'required', 'string', 'regex:' . User::REGEX_USERNAME,
'max:255', 'unique:users,username'
],
'email' => 'required|string|email|max:255|unique:users,email',
'password' => [
'required', 'string', 'max:255',
// we can set additional password requirements below
Password::min(8),
],
];
}
/**
* @return array<mixed>
*/
public function validationData()
{
return Arr::wrap($this->input('user'));
}
}
| +---- UpdateArticleRequest.php
<?php
namespace App\Http\Requests\Api;
class UpdateArticleRequest extends BaseArticleRequest
{
public function rules()
{
return array_merge_recursive(parent::rules(), [
'title' => ['required_without_all:description,body'],
'slug' => ['required_with:title'],
'description' => ['required_without_all:title,body'],
'body' => ['required_without_all:title,description'],
]);
}
}
| +---- UpdateUserRequest.php
<?php
namespace App\Http\Requests\Api;
use App\Models\User;
use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Support\Arr;
use Illuminate\Validation\Rule;
use InvalidArgumentException;
class UpdateUserRequest extends FormRequest
{
/**
* Get the validation rules that apply to the request.
*
* @return array<string, mixed>
*/
public function rules()
{
/** @var \App\Models\User|null $user */
$user = $this->user();
if ($user === null) {
throw new InvalidArgumentException('User not authenticated.');
}
return [
'username' => [
'sometimes', 'string', 'max:255', 'regex:' . User::REGEX_USERNAME,
Rule::unique('users', 'username')
->ignore($user->getKey()),
],
'email' => [
'sometimes', 'string', 'email', 'max:255',
Rule::unique('users', 'email')
->ignore($user->getKey()),
],
'bio' => 'sometimes|nullable|string',
'image' => 'sometimes|nullable|string|url',
];
}
/**
* @return array<mixed>
*/
public function validationData()
{
return Arr::wrap($this->input('user'));
}
}
| +---- Resources
| +---- Api
| +---- ArticleResource.php
<?php
namespace App\Http\Resources\Api;
use Illuminate\Http\Resources\Json\JsonResource;
/**
* Class ArticleResource
*
* @package App\Http\Resources
* @property \App\Models\Article $resource
*/
class ArticleResource extends JsonResource
{
/**
* The "data" wrapper that should be applied.
*
* @var string
*/
public static $wrap = 'article';
/**
* Transform the resource into an array.
*
* @param \Illuminate\Http\Request $request
* @return array<string, mixed>
*/
public function toArray($request)
{
/** @var \App\Models\User|null $user */
$user = $request->user();
return [
'slug' => $this->resource->slug,
'title' => $this->resource->title,
'description' => $this->resource->description,
'body' => $this->resource->body,
'tagList' => new TagsCollection($this->resource->tags),
'createdAt' => $this->resource->created_at,
'updatedAt' => $this->resource->updated_at,
'favorited' => $this->when($user !== null, fn() =>
$this->resource->favoredBy($user)
),
'favoritesCount' => $this->resource->favoredUsers->count(),
'author' => new ProfileResource($this->resource->author),
];
}
}
| +---- ArticlesCollection.php
<?php
namespace App\Http\Resources\Api;
use Illuminate\Http\Resources\Json\ResourceCollection;
/**
* Class ArticlesCollection
*
* @package App\Http\Resources
* @property \Illuminate\Support\Collection<\App\Models\Article> $collection
*/
class ArticlesCollection extends ResourceCollection
{
/**
* The "data" wrapper that should be applied.
*
* @var string|null
*/
public static $wrap = 'articles';
/**
* The resource that this resource collects.
*
* @var string
*/
public $collects = ArticleResource::class;
/**
* Get additional data that should be returned with the resource array.
*
* @param \Illuminate\Http\Request $request
* @return array<string, mixed>
*/
public function with($request)
{
return [
'articlesCount' => $this->collection->count(),
];
}
}
| +---- BaseUserResource.php
<?php
namespace App\Http\Resources\Api;
use Illuminate\Http\Resources\Json\JsonResource;
/**
* Class BaseUserResource
*
* @package App\Http\Resources
* @property \App\Models\User $resource
*/
abstract class BaseUserResource extends JsonResource
{
/**
* Transform the resource into an array.
*
* @param \Illuminate\Http\Request $request
* @return array<string, mixed>
*/
public function toArray($request)
{
return [
'username' => $this->resource->username,
'bio' => $this->resource->bio,
'image' => $this->resource->image,
];
}
}
| +---- CommentResource.php
<?php
namespace App\Http\Resources\Api;
use Illuminate\Http\Resources\Json\JsonResource;
/**
* Class CommentResource
*
* @package App\Http\Resources
* @property \App\Models\Comment $resource
*/
class CommentResource extends JsonResource
{
/**
* The "data" wrapper that should be applied.
*
* @var string
*/
public static $wrap = 'comment';
/**
* Transform the resource into an array.
*
* @param \Illuminate\Http\Request $request
* @return array<string, mixed>
*/
public function toArray($request)
{
return [
'id' => $this->resource->getKey(),
'createdAt' => $this->resource->created_at,
'updatedAt' => $this->resource->updated_at,
'body' => $this->resource->body,
'author' => new ProfileResource($this->resource->author),
];
}
}
| +---- CommentsCollection.php
<?php
namespace App\Http\Resources\Api;
use Illuminate\Http\Resources\Json\ResourceCollection;
/**
* Class CommentsCollection
*
* @package App\Http\Resources
* @property \Illuminate\Support\Collection<\App\Models\Comment> $collection
*/
class CommentsCollection extends ResourceCollection
{
/**
* The "data" wrapper that should be applied.
*
* @var string|null
*/
public static $wrap = 'comments';
/**
* The resource that this resource collects.
*
* @var string
*/
public $collects = CommentResource::class;
}
| +---- ProfileResource.php
<?php
namespace App\Http\Resources\Api;
class ProfileResource extends BaseUserResource
{
/**
* The "data" wrapper that should be applied.
*
* @var string
*/
public static $wrap = 'profile';
/**
* Transform the resource into an array.
*
* @param \Illuminate\Http\Request $request
* @return array<string, mixed>
*/
public function toArray($request)
{
/** @var \App\Models\User|null $user */
$user = $request->user();
return array_merge(parent::toArray($request), [
'following' => $this->when($user !== null, fn() =>
$user->following($this->resource)
),
]);
}
}
| +---- TagResource.php
<?php
namespace App\Http\Resources\Api;
use Illuminate\Http\Resources\Json\JsonResource;
/**
* Class TagResource
*
* @package App\Http\Resources
* @property \App\Models\Tag $resource
*/
class TagResource extends JsonResource
{
/**
* Transform the resource into an array.
*
* @param \Illuminate\Http\Request $request
* @return array<string, mixed>
*/
public function toArray($request)
{
return [
'name' => $this->resource->name,
];
}
}
| +---- TagsCollection.php
<?php
namespace App\Http\Resources\Api;
use Illuminate\Http\Resources\Json\ResourceCollection;
/**
* Class TagsCollection
*
* @package App\Http\Resources
* @property \Illuminate\Support\Collection<\App\Models\Tag> $collection
*/
class TagsCollection extends ResourceCollection
{
/**
* The "data" wrapper that should be applied.
*
* @var string|null
*/
public static $wrap = 'tags';
/**
* The resource that this resource collects.
*
* @var string
*/
public $collects = TagResource::class;
/**
* Transform the resource collection into an array.
*
* @param \Illuminate\Http\Request $request
* @return \Illuminate\Support\Collection<int, mixed>
*/
public function toArray($request)
{
return $this->collection->pluck('name');
}
}
| +---- UserResource.php
<?php
namespace App\Http\Resources\Api;
use App\Jwt;
class UserResource extends BaseUserResource
{
/**
* The "data" wrapper that should be applied.
*
* @var string
*/
public static $wrap = 'user';
/**
* Transform the resource into an array.
*
* @param \Illuminate\Http\Request $request
* @return array<string, mixed>
*/
public function toArray($request)
{
return array_merge(parent::toArray($request), [
'email' => $this->resource->email,
'token' => Jwt\Generator::token($this->resource),
]);
}
}
+---- Jwt
| +---- Builder.php
<?php
namespace App\Jwt;
use App\Contracts\JwtBuilderInterface;
use App\Contracts\JwtTokenInterface;
use App\Contracts\JwtSubjectInterface;
class Builder implements JwtBuilderInterface
{
private JwtTokenInterface $jwt;
public function __construct()
{
$this->jwt = new Token();
}
public static function build(): JwtBuilderInterface
{
return new self();
}
public function issuedAt(int $timestamp): JwtBuilderInterface
{
$this->jwt->putToPayload('iat', $timestamp);
return $this;
}
public function expiresAt(int $timestamp): JwtBuilderInterface
{
$this->jwt->putToPayload('exp', $timestamp);
return $this;
}
public function subject(mixed $identifier): JwtBuilderInterface
{
if ($identifier instanceof JwtSubjectInterface) {
$identifier = $identifier->getJwtIdentifier();
}
$this->jwt->putToPayload('sub', $identifier);
return $this;
}
public function withClaim(string $key, mixed $value = null): JwtBuilderInterface
{
$this->jwt->putToPayload($key, $value);
return $this;
}
public function withHeader(string $key, mixed $value = null): JwtBuilderInterface
{
$this->jwt->putToHeader($key, $value);
return $this;
}
public function getToken(): JwtTokenInterface
{
return $this->jwt;
}
}
| +---- Generator.php
<?php
namespace App\Jwt;
use App\Contracts\JwtGeneratorInterface;
use App\Contracts\JwtTokenInterface;
use App\Contracts\JwtSubjectInterface;
use Illuminate\Support\Carbon;
use InvalidArgumentException;
class Generator implements JwtGeneratorInterface
{
public static function signature(JwtTokenInterface $token): string
{
$secret = config('app.key');
if ($secret === null) {
throw new InvalidArgumentException('No APP_KEY specified.');
}
$encodedData = self::encodeData($token);
return hash_hmac('sha256', $encodedData, $secret);
}
public static function token(JwtSubjectInterface $user): string
{
$now = Carbon::now();
$expiresIn = (int) config('jwt.expiration');
$expiresAt = $now->addSeconds($expiresIn);
$token = Builder::build()
->subject($user)
->issuedAt($now->getTimestamp())
->expiresAt($expiresAt->getTimestamp())
->getToken();
$parts = [
self::encodeData($token),
base64_encode(self::signature($token)),
];
return implode('.', $parts);
}
/**
* Encode JwtToken headers and payload.
*
* @param \App\Contracts\JwtTokenInterface $token
* @return string
*/
private static function encodeData(JwtTokenInterface $token): string
{
$jsonParts = [
$token->headers()->toJson(),
$token->claims()->toJson(),
];
$encoded = array_map('base64_encode', $jsonParts);
return implode('.', $encoded);
}
}
| +---- Parser.php
<?php
namespace App\Jwt;
use App\Contracts\JwtTokenInterface;
use App\Contracts\JwtParserInterface;
use App\Exceptions\JwtParseException;
class Parser implements JwtParserInterface
{
/**
* @param string $token
* @return \App\Contracts\JwtTokenInterface
* @throws \App\Exceptions\JwtParseException
* @throws \JsonException
*/
public static function parse(string $token): JwtTokenInterface
{
$parts = explode('.', $token);
if (count($parts) !== 3) {
throw new JwtParseException('JwtToken parts count does not match.');
}
$base64Decoded = array_map(function ($part) {
/** @var false|string $decoded */
$decoded = base64_decode($part, true);
if ($decoded === false) {
throw new JwtParseException('JwtToken parts base64 decode error.');
}
return $decoded;
}, $parts);
[$jsonHeader, $jsonPayload, $signature] = $base64Decoded;
$jsonDecoded = array_map(fn (string $part) =>
json_decode($part, true, 512, JSON_THROW_ON_ERROR),
[$jsonHeader, $jsonPayload]
);
[$header, $payload] = $jsonDecoded;
return new Token($header, $payload, $signature);
}
}
| +---- Token.php
<?php
namespace App\Jwt;
use App\Contracts\JwtTokenInterface;
use Illuminate\Support\Collection;
class Token implements JwtTokenInterface
{
/** User-supplied signature */
private ?string $signature;
/** @var Collection<string, mixed> */
private Collection $header;
/** @var Collection<string, mixed> */
private Collection $payload;
/**
* Token constructor.
*
* @param array<string, mixed>|null $headers
* @param array<string, mixed>|null $claims
* @param string|null $signature User-supplied signature
*/
public function __construct(
array $headers = null,
array $claims = null,
string $signature = null)
{
$this->header = collect(
array_merge($this->getDefaultHeaders(), $headers ?? [])
);
$this->payload = collect($claims);
$this->signature = $signature;
}
public function getDefaultHeaders(): array
{
$headers = config('jwt.headers');
return is_array($headers) ? $headers : [];
}
public function headers(): Collection
{
return clone $this->header;
}
public function claims(): Collection
{
return clone $this->payload;
}
public function getUserSignature(): ?string
{
return $this->signature;
}
public function putToPayload(string $key, mixed $value): void
{
$this->payload->put($key, $value);
}
public function putToHeader(string $key, mixed $value): void
{
$this->header->put($key, $value);
}
public function setUserSignature(string $signature): void
{
$this->signature = $signature;
}
public function getSubject(): mixed
{
return $this->payload->get('sub');
}
public function getExpiration(): int
{
return (int) $this->payload->get('exp');
}
}
| +---- Validator.php
<?php
namespace App\Jwt;
use App\Contracts\JwtTokenInterface;
use App\Contracts\JwtValidatorInterface;
use App\Models\User;
use Illuminate\Support\Carbon;
class Validator implements JwtValidatorInterface
{
public static function validate(JwtTokenInterface $token): bool
{
$signature = $token->getUserSignature();
if ($signature === null) {
return false;
}
if (!hash_equals(Generator::signature($token), $signature)) {
return false;
}
$headers = $token->headers();
if ($headers->get('alg') !== 'HS256'
|| $headers->get('typ') !== 'JWT') {
return false;
}
$expiresAt = $token->getExpiration();
if ($expiresAt === 0) {
return false;
}
$expirationDate = Carbon::createFromTimestamp($expiresAt);
$currentDate = Carbon::now();
if ($expirationDate->lessThan($currentDate)) {
return false;
}
$subject = $token->getSubject();
if (User::whereKey($subject)->doesntExist()) {
return false;
}
return true;
}
}
+---- Models
| +---- Article.php
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
/**
* App\Models\Article
*
* @property int $id
* @property int $author_id
* @property string $slug
* @property string $title
* @property string $description
* @property string $body
* @property \Illuminate\Support\Carbon|null $created_at
* @property \Illuminate\Support\Carbon|null $updated_at
* @property-read \App\Models\User $author
* @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\Comment[] $comments
* @property-read int|null $comments_count
* @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\User[] $favoredUsers
* @property-read int|null $favored_users_count
* @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\Tag[] $tags
* @property-read int|null $tags_count
* @method static \Database\Factories\ArticleFactory factory(...$parameters)
* @method static Builder|Article favoredByUser(string $username)
* @method static Builder|Article followedAuthorsOf(\App\Models\User $user)
* @method static Builder|Article havingTag(string $tag)
* @method static Builder|Article list(int $take, int $skip)
* @method static Builder|Article newModelQuery()
* @method static Builder|Article newQuery()
* @method static Builder|Article ofAuthor(string $username)
* @method static Builder|Article query()
* @method static Builder|Article whereAuthorId($value)
* @method static Builder|Article whereBody($value)
* @method static Builder|Article whereCreatedAt($value)
* @method static Builder|Article whereDescription($value)
* @method static Builder|Article whereId($value)
* @method static Builder|Article whereSlug($value)
* @method static Builder|Article whereTitle($value)
* @method static Builder|Article whereUpdatedAt($value)
* @mixin \Eloquent
*/
class Article extends Model
{
use HasFactory;
/**
* The attributes that are mass assignable.
*
* @var string[]
*/
protected $fillable = [
'author_id',
'slug',
'title',
'description',
'body',
];
/**
* Determine if user favored the article.
*
* @param \App\Models\User $user
* @return bool
*/
public function favoredBy(User $user): bool
{
return $this->favoredUsers()
->whereKey($user->getKey())
->exists();
}
/**
* Scope article list.
*
* @param \Illuminate\Database\Eloquent\Builder<self> $query
* @param int $take
* @param int $skip
* @return \Illuminate\Database\Eloquent\Builder<self>
*/
public function scopeList(Builder $query, int $take, int $skip): Builder
{
return $query->latest()
->limit($take)
->offset($skip);
}
/**
* Scope articles having a tag.
*
* @param \Illuminate\Database\Eloquent\Builder<self> $query
* @param string $tag
* @return \Illuminate\Database\Eloquent\Builder<self>
*/
public function scopeHavingTag(Builder $query, string $tag): Builder
{
return $query->whereHas('tags', fn (Builder $builder) =>
$builder->where('name', $tag)
);
}
/**
* Scope to article author.
*
* @param \Illuminate\Database\Eloquent\Builder<self> $query
* @param string $username
* @return \Illuminate\Database\Eloquent\Builder<self>
*/
public function scopeOfAuthor(Builder $query, string $username): Builder
{
return $query->whereHas('author', fn (Builder $builder) =>
$builder->where('username', $username)
);
}
/**
* Scope articles to favored by a user.
*
* @param \Illuminate\Database\Eloquent\Builder<self> $query
* @param string $username
* @return \Illuminate\Database\Eloquent\Builder<self>
*/
public function scopeFavoredByUser(Builder $query, string $username): Builder
{
return $query->whereHas('favoredUsers', fn (Builder $builder) =>
$builder->where('username', $username)
);
}
/**
* Scope articles to author's of a user.
*
* @param \Illuminate\Database\Eloquent\Builder<self> $query
* @param \App\Models\User $user
* @return \Illuminate\Database\Eloquent\Builder<self>
*/
public function scopeFollowedAuthorsOf(Builder $query, User $user): Builder
{
return $query->whereHas('author', fn (Builder $builder) =>
$builder->whereIn('id', $user->authors->pluck('id'))
);
}
/**
* Attach tags to article.
*
* @param array<string> $tags
*/
public function attachTags(array $tags): void
{
foreach ($tags as $tagName) {
$tag = Tag::firstOrCreate([
'name' => $tagName,
]);
$this->tags()->syncWithoutDetaching($tag);
}
}
/**
* Article author.
*
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo<User, self>
*/
public function author()
{
return $this->belongsTo(User::class);
}
/**
* Article tags.
*
* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany<Tag>
*/
public function tags()
{
return $this->belongsToMany(Tag::class);
}
/**
* Get the comments for the article.
*
* @return \Illuminate\Database\Eloquent\Relations\HasMany<Comment>
*/
public function comments()
{
return $this->hasMany(Comment::class);
}
/**
* Get users favored the article.
*
* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany<User>
*/
public function favoredUsers()
{
return $this->belongsToMany(User::class, 'article_favorite');
}
}
| +---- Comment.php
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
/**
* App\Models\Comment
*
* @property int $id
* @property int $article_id
* @property int $author_id
* @property string $body
* @property \Illuminate\Support\Carbon|null $created_at
* @property \Illuminate\Support\Carbon|null $updated_at
* @property-read \App\Models\Article $article
* @property-read \App\Models\User $author
* @method static \Database\Factories\CommentFactory factory(...$parameters)
* @method static \Illuminate\Database\Eloquent\Builder|Comment newModelQuery()
* @method static \Illuminate\Database\Eloquent\Builder|Comment newQuery()
* @method static \Illuminate\Database\Eloquent\Builder|Comment query()
* @method static \Illuminate\Database\Eloquent\Builder|Comment whereArticleId($value)
* @method static \Illuminate\Database\Eloquent\Builder|Comment whereAuthorId($value)
* @method static \Illuminate\Database\Eloquent\Builder|Comment whereBody($value)
* @method static \Illuminate\Database\Eloquent\Builder|Comment whereCreatedAt($value)
* @method static \Illuminate\Database\Eloquent\Builder|Comment whereId($value)
* @method static \Illuminate\Database\Eloquent\Builder|Comment whereUpdatedAt($value)
* @mixin \Eloquent
*/
class Comment extends Model
{
use HasFactory;
/**
* The attributes that are mass assignable.
*
* @var string[]
*/
protected $fillable = [
'article_id',
'author_id',
'body',
];
/**
* Comment's article.
*
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo<Article, self>
*/
public function article()
{
return $this->belongsTo(Article::class);
}
/**
* Comment's author.
*
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo<User, self>
*/
public function author()
{
return $this->belongsTo(User::class);
}
}
| +---- Tag.php
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
/**
* App\Models\Tag
*
* @property int $id
* @property string $name
* @property \Illuminate\Support\Carbon|null $created_at
* @property \Illuminate\Support\Carbon|null $updated_at
* @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\Article[] $articles
* @property-read int|null $articles_count
* @method static \Database\Factories\TagFactory factory(...$parameters)
* @method static \Illuminate\Database\Eloquent\Builder|Tag newModelQuery()
* @method static \Illuminate\Database\Eloquent\Builder|Tag newQuery()
* @method static \Illuminate\Database\Eloquent\Builder|Tag query()
* @method static \Illuminate\Database\Eloquent\Builder|Tag whereCreatedAt($value)
* @method static \Illuminate\Database\Eloquent\Builder|Tag whereId($value)
* @method static \Illuminate\Database\Eloquent\Builder|Tag whereName($value)
* @method static \Illuminate\Database\Eloquent\Builder|Tag whereUpdatedAt($value)
* @mixin \Eloquent
*/
class Tag extends Model
{
use HasFactory;
/**
* The attributes that are mass assignable.
*
* @var string[]
*/
protected $fillable = [
'name',
];
/**
* Tagged articles.
*
* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany<Article>
*/
public function articles()
{
return $this->belongsToMany(Article::class);
}
}
| +---- User.php
<?php
namespace App\Models;
use App\Contracts\JwtSubjectInterface;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;
use Laravel\Sanctum\HasApiTokens;
/**
* App\Models\User
*
* @property int $id
* @property string|null $name
* @property string $email
* @property \Illuminate\Support\Carbon|null $email_verified_at
* @property string $password
* @property string|null $remember_token
* @property \Illuminate\Support\Carbon|null $created_at
* @property \Illuminate\Support\Carbon|null $updated_at
* @property string $username
* @property string|null $bio
* @property string|null $image
* @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\Article[] $articles
* @property-read int|null $articles_count
* @property-read \Illuminate\Database\Eloquent\Collection|User[] $authors
* @property-read int|null $authors_count
* @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\Comment[] $comments
* @property-read int|null $comments_count
* @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\Article[] $favorites
* @property-read int|null $favorites_count
* @property-read \Illuminate\Database\Eloquent\Collection|User[] $followers
* @property-read int|null $followers_count
* @property-read \Illuminate\Notifications\DatabaseNotificationCollection|\Illuminate\Notifications\DatabaseNotification[] $notifications
* @property-read int|null $notifications_count
* @property-read \Illuminate\Database\Eloquent\Collection|\Laravel\Sanctum\PersonalAccessToken[] $tokens
* @property-read int|null $tokens_count
* @method static \Database\Factories\UserFactory factory(...$parameters)
* @method static \Illuminate\Database\Eloquent\Builder|User newModelQuery()
* @method static \Illuminate\Database\Eloquent\Builder|User newQuery()
* @method static \Illuminate\Database\Eloquent\Builder|User query()
* @method static \Illuminate\Database\Eloquent\Builder|User whereBio($value)
* @method static \Illuminate\Database\Eloquent\Builder|User whereCreatedAt($value)
* @method static \Illuminate\Database\Eloquent\Builder|User whereEmail($value)
* @method static \Illuminate\Database\Eloquent\Builder|User whereEmailVerifiedAt($value)
* @method static \Illuminate\Database\Eloquent\Builder|User whereId($value)
* @method static \Illuminate\Database\Eloquent\Builder|User whereImage($value)
* @method static \Illuminate\Database\Eloquent\Builder|User whereName($value)
* @method static \Illuminate\Database\Eloquent\Builder|User wherePassword($value)
* @method static \Illuminate\Database\Eloquent\Builder|User whereRememberToken($value)
* @method static \Illuminate\Database\Eloquent\Builder|User whereUpdatedAt($value)
* @method static \Illuminate\Database\Eloquent\Builder|User whereUsername($value)
* @mixin \Eloquent
*/
class User extends Authenticatable implements JwtSubjectInterface
{
use HasApiTokens, HasFactory, Notifiable;
/**
* Regular expression for username.
*/
public const REGEX_USERNAME = '/^[\pL\pM\pN._-]+$/u';
/**
* The attributes that are mass assignable.
*
* @var array<int, string>
*/
protected $fillable = [
'username',
'email',
'password',
'bio',
'image',
];
/**
* The attributes that should be hidden for serialization.
*
* @var array<int, string>
*/
protected $hidden = [
'password',
'remember_token',
];
/**
* The attributes that should be cast.
*
* @var array<string, string>
*/
protected $casts = [
'email_verified_at' => 'datetime',
];
public function getJwtIdentifier(): mixed
{
return $this->getKey();
}
/**
* Determine if user is following an author.
*
* @param \App\Models\User $author
* @return bool
*/
public function following(User $author): bool
{
return $this->authors()
->whereKey($author->getKey())
->exists();
}
/**
* Determine if author followed by a user.
*
* @param \App\Models\User $follower
* @return bool
*/
public function followedBy(User $follower): bool
{
return $this->followers()
->whereKey($follower->getKey())
->exists();
}
/**
* The authors that the user follows.
*
* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany<User>
*/
public function authors()
{
return $this->belongsToMany(User::class, 'author_follower', 'author_id', 'follower_id');
}
/**
* The followers of the author.
*
* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany<User>
*/
public function followers()
{
return $this->belongsToMany(User::class, 'author_follower', 'follower_id', 'author_id');
}
/**
* Get the comments of the user.
*
* @return \Illuminate\Database\Eloquent\Relations\HasMany<Comment>
*/
public function comments()
{
return $this->hasMany(Comment::class, 'author_id');
}
/**
* Get user written articles.
*
* @return \Illuminate\Database\Eloquent\Relations\HasMany<Article>
*/
public function articles()
{
return $this->hasMany(Article::class, 'author_id');
}
/**
* Get user favorite articles.
*
* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany<Article>
*/
public function favorites()
{
return $this->belongsToMany(Article::class, 'article_favorite');
}
}
+---- Policies
| +---- ArticlePolicy.php
<?php
namespace App\Policies;
use App\Models\Article;
use App\Models\User;
use Illuminate\Auth\Access\HandlesAuthorization;
class ArticlePolicy
{
use HandlesAuthorization;
/**
* Determine whether the user can update the model.
*
* @param \App\Models\User $user
* @param \App\Models\Article $article
* @return bool
*/
public function update(User $user, Article $article): bool
{
return $user->getKey() === $article->author->getKey();
}
/**
* Determine whether the user can delete the model.
*
* @param \App\Models\User $user
* @param \App\Models\Article $article
* @return bool
*/
public function delete(User $user, Article $article): bool
{
return $this->update($user, $article);
}
}
| +---- CommentPolicy.php
<?php
namespace App\Policies;
use App\Models\Comment;
use App\Models\User;
use Illuminate\Auth\Access\HandlesAuthorization;
class CommentPolicy
{
use HandlesAuthorization;
/**
* Determine whether the user can delete the model.
*
* @param \App\Models\User $user
* @param \App\Models\Comment $comment
* @return bool
*/
public function delete(User $user, Comment $comment): bool
{
return $user->getKey() === $comment->author->getKey();
}
}
+---- Providers
| +---- AppServiceProvider.php
<?php
namespace App\Providers;
use Illuminate\Support\ServiceProvider;
class AppServiceProvider extends ServiceProvider
{
/**
* Register any application services.
*
* @return void
*/
public function register()
{
//
}
/**
* Bootstrap any application services.
*
* @return void
*/
public function boot()
{
//
}
}
| +---- AuthServiceProvider.php
<?php
namespace App\Providers;
use App\Auth\JwtGuard;
use Illuminate\Foundation\Support\Providers\AuthServiceProvider as ServiceProvider;
use Illuminate\Support\Facades\Auth;
use InvalidArgumentException;
class AuthServiceProvider extends ServiceProvider
{
/**
* The policy mappings for the application.
*
* @var array<class-string, class-string>
*/
protected $policies = [
// 'App\Models\Model' => 'App\Policies\ModelPolicy',
];
/**
* Register any authentication / authorization services.
*
* @return void
*/
public function boot()
{
$this->registerPolicies();
Auth::extend('jwt', function ($app, $name, array $config) {
$provider = Auth::createUserProvider($config['provider'] ?? null);
if ($provider === null) {
throw new InvalidArgumentException('Invalid UserProvider config specified.');
}
return new JwtGuard($provider, $app['request'], $config['input_key'] ?? 'token');
});
}
}
| +---- BroadcastServiceProvider.php
<?php
namespace App\Providers;
use Illuminate\Support\Facades\Broadcast;
use Illuminate\Support\ServiceProvider;
class BroadcastServiceProvider extends ServiceProvider
{
/**
* Bootstrap any application services.
*
* @return void
*/
public function boot()
{
Broadcast::routes();
require base_path('routes/channels.php');
}
}
| +---- EventServiceProvider.php
<?php
namespace App\Providers;
use Illuminate\Auth\Events\Registered;
use Illuminate\Auth\Listeners\SendEmailVerificationNotification;
use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
use Illuminate\Support\Facades\Event;
class EventServiceProvider extends ServiceProvider
{
/**
* The event listener mappings for the application.
*
* @var array<class-string, array<int, class-string>>
*/
protected $listen = [
/*Registered::class => [
SendEmailVerificationNotification::class,
],*/
];
/**
* Register any events for your application.
*
* @return void
*/
public function boot()
{
//
}
/**
* Determine if events and listeners should be automatically discovered.
*
* @return bool
*/
public function shouldDiscoverEvents()
{
return false;
}
}
| +---- RouteServiceProvider.php
<?php
namespace App\Providers;
use Illuminate\Cache\RateLimiting\Limit;
use Illuminate\Foundation\Support\Providers\RouteServiceProvider as ServiceProvider;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\RateLimiter;
use Illuminate\Support\Facades\Route;
class RouteServiceProvider extends ServiceProvider
{
/**
* The path to the "home" route for your application.
*
* This is used by Laravel authentication to redirect users after login.
*
* @var string
*/
public const HOME = '/home';
/**
* Define your route model bindings, pattern filters, etc.
*
* @return void
*/
public function boot()
{
$this->configureRateLimiting();
$this->routes(function () {
Route::prefix('api')
->middleware('api')
->group(base_path('routes/api.php'));
Route::middleware('web')
->group(base_path('routes/web.php'));
});
}
/**
* Configure the rate limiters for the application.
*
* @return void
*/
protected function configureRateLimiting()
{
RateLimiter::for('api', function (Request $request) {
return Limit::perMinute(60)->by($request->user()?->id ?: $request->ip());
});
}
}
bootstrap
+---- app.php
<?php
/*
|--------------------------------------------------------------------------
| Create The Application
|--------------------------------------------------------------------------
|
| The first thing we will do is create a new Laravel application instance
| which serves as the "glue" for all the components of Laravel, and is
| the IoC container for the system binding all of the various parts.
|
*/
$app = new Illuminate\Foundation\Application(
$_ENV['APP_BASE_PATH'] ?? dirname(__DIR__)
);
/*
|--------------------------------------------------------------------------
| Bind Important Interfaces
|--------------------------------------------------------------------------
|
| Next, we need to bind some important interfaces into the container so
| we will be able to resolve them when needed. The kernels serve the
| incoming requests to this application from both the web and CLI.
|
*/
$app->singleton(
Illuminate\Contracts\Http\Kernel::class,
App\Http\Kernel::class
);
$app->singleton(
Illuminate\Contracts\Console\Kernel::class,
App\Console\Kernel::class
);
$app->singleton(
Illuminate\Contracts\Debug\ExceptionHandler::class,
App\Exceptions\Handler::class
);
/*
|--------------------------------------------------------------------------
| Return The Application
|--------------------------------------------------------------------------
|
| This script returns the application instance. The instance is given to
| the calling script so we can separate the building of the instances
| from the actual running of the application and sending responses.
|
*/
return $app;
+---- cache
| +---- .gitignore
*
!.gitignore
composer.json
{
"name": "f1amy/laravel-realworld-example-app",
"type": "project",
"description": "Laravel framework RealWorld backend implementation.",
"keywords": ["laravel", "jwt", "crud", "demo-app", "realworld", "rest-api"],
"homepage": "https://github.com/f1amy/laravel-realworld-example-app",
"license": "MIT",
"require": {
"php": "^8.0.2",
"ext-json": "*",
"ext-pdo": "*",
"darkaonline/l5-swagger": "^8.3",
"guzzlehttp/guzzle": "^7.2",
"laravel/framework": "^9.2",
"laravel/sanctum": "^2.14.1",
"laravel/tinker": "^2.7"
},
"require-dev": {
"barryvdh/laravel-ide-helper": "^2.12",
"brianium/paratest": "^6.4",
"fakerphp/faker": "^1.9.1",
"laravel/sail": "^1.0.1",
"mockery/mockery": "^1.4.4",
"nunomaduro/collision": "^6.1",
"nunomaduro/larastan": "^2.1",
"phpstan/extension-installer": "^1.1",
"phpstan/phpstan": "^1.4",
"phpstan/phpstan-phpunit": "^1.0",
"phpunit/phpunit": "^9.5.10",
"roave/security-advisories": "dev-latest",
"spatie/laravel-ignition": "^1.0"
},
"autoload": {
"psr-4": {
"App\\": "app/",
"Database\\Factories\\": "database/factories/",
"Database\\Seeders\\": "database/seeders/"
}
},
"autoload-dev": {
"psr-4": {
"Tests\\": "tests/"
}
},
"scripts": {
"post-autoload-dump": [
"Illuminate\\Foundation\\ComposerScripts::postAutoloadDump",
"@php artisan package:discover --ansi"
],
"post-update-cmd": [
"@php artisan vendor:publish --tag=laravel-assets --ansi --force",
"[ $COMPOSER_DEV_MODE -eq 0 ] || $PHP_BINARY artisan ide-helper:generate -WHM",
"[ $COMPOSER_DEV_MODE -eq 0 ] || $PHP_BINARY artisan ide-helper:meta"
],
"post-root-package-install": [
"@php -r \"file_exists('.env') || copy('.env.example', '.env');\""
],
"post-create-project-cmd": [
"@php artisan key:generate --ansi"
]
},
"extra": {
"laravel": {
"dont-discover": []
}
},
"config": {
"optimize-autoloader": true,
"preferred-install": "dist",
"sort-packages": true,
"platform": {
"php": "8.0.2"
},
"allow-plugins": {
"phpstan/extension-installer": true
}
},
"minimum-stability": "dev",
"prefer-stable": true
}
config
+---- app.php
<?php
use Illuminate\Support\Facades\Facade;
return [
/*
|--------------------------------------------------------------------------
| Application Name
|--------------------------------------------------------------------------
|
| This value is the name of your application. This value is used when the
| framework needs to place the application's name in a notification or
| any other location as required by the application or its packages.
|
*/
'name' => env('APP_NAME', 'Laravel'),
/*
|--------------------------------------------------------------------------
| Application Environment
|--------------------------------------------------------------------------
|
| This value determines the "environment" your application is currently
| running in. This may determine how you prefer to configure various
| services the application utilizes. Set this in your ".env" file.
|
*/
'env' => env('APP_ENV', 'production'),
/*
|--------------------------------------------------------------------------
| Application Debug Mode
|--------------------------------------------------------------------------
|
| When your application is in debug mode, detailed error messages with
| stack traces will be shown on every error that occurs within your
| application. If disabled, a simple generic error page is shown.
|
*/
'debug' => (bool) env('APP_DEBUG', false),
/*
|--------------------------------------------------------------------------
| Application URL
|--------------------------------------------------------------------------
|
| This URL is used by the console to properly generate URLs when using
| the Artisan command line tool. You should set this to the root of
| your application so that it is used when running Artisan tasks.
|
*/
'url' => env('APP_URL', 'http://localhost'),
'asset_url' => env('ASSET_URL'),
/*
|--------------------------------------------------------------------------
| Application Timezone
|--------------------------------------------------------------------------
|
| Here you may specify the default timezone for your application, which
| will be used by the PHP date and date-time functions. We have gone
| ahead and set this to a sensible default for you out of the box.
|
*/
'timezone' => 'UTC',
/*
|--------------------------------------------------------------------------
| Application Locale Configuration
|--------------------------------------------------------------------------
|
| The application locale determines the default locale that will be used
| by the translation service provider. You are free to set this value
| to any of the locales which will be supported by the application.
|
*/
'locale' => 'en',
/*
|--------------------------------------------------------------------------
| Application Fallback Locale
|--------------------------------------------------------------------------
|
| The fallback locale determines the locale to use when the current one
| is not available. You may change the value to correspond to any of
| the language folders that are provided through your application.
|
*/
'fallback_locale' => 'en',
/*
|--------------------------------------------------------------------------
| Faker Locale
|--------------------------------------------------------------------------
|
| This locale will be used by the Faker PHP library when generating fake
| data for your database seeds. For example, this will be used to get
| localized telephone numbers, street address information and more.
|
*/
'faker_locale' => 'en_US',
/*
|--------------------------------------------------------------------------
| Encryption Key
|--------------------------------------------------------------------------
|
| This key is used by the Illuminate encrypter service and should be set
| to a random, 32 character string, otherwise these encrypted strings
| will not be safe. Please do this before deploying an application!
|
*/
'key' => env('APP_KEY'),
'cipher' => 'AES-256-CBC',
/*
|--------------------------------------------------------------------------
| Autoloaded Service Providers
|--------------------------------------------------------------------------
|
| The service providers listed here will be automatically loaded on the
| request to your application. Feel free to add your own services to
| this array to grant expanded functionality to your applications.
|
*/
'providers' => [
/*
* Laravel Framework Service Providers...
*/
Illuminate\Auth\AuthServiceProvider::class,
Illuminate\Broadcasting\BroadcastServiceProvider::class,
Illuminate\Bus\BusServiceProvider::class,
Illuminate\Cache\CacheServiceProvider::class,
Illuminate\Foundation\Providers\ConsoleSupportServiceProvider::class,
Illuminate\Cookie\CookieServiceProvider::class,
Illuminate\Database\DatabaseServiceProvider::class,
Illuminate\Encryption\EncryptionServiceProvider::class,
Illuminate\Filesystem\FilesystemServiceProvider::class,
Illuminate\Foundation\Providers\FoundationServiceProvider::class,
Illuminate\Hashing\HashServiceProvider::class,
Illuminate\Mail\MailServiceProvider::class,
Illuminate\Notifications\NotificationServiceProvider::class,
Illuminate\Pagination\PaginationServiceProvider::class,
Illuminate\Pipeline\PipelineServiceProvider::class,
Illuminate\Queue\QueueServiceProvider::class,
Illuminate\Redis\RedisServiceProvider::class,
Illuminate\Auth\Passwords\PasswordResetServiceProvider::class,
Illuminate\Session\SessionServiceProvider::class,
Illuminate\Translation\TranslationServiceProvider::class,
Illuminate\Validation\ValidationServiceProvider::class,
Illuminate\View\ViewServiceProvider::class,
/*
* Package Service Providers...
*/
/*
* Application Service Providers...
*/
App\Providers\AppServiceProvider::class,
App\Providers\AuthServiceProvider::class,
// App\Providers\BroadcastServiceProvider::class,
App\Providers\EventServiceProvider::class,
App\Providers\RouteServiceProvider::class,
],
/*
|--------------------------------------------------------------------------
| Class Aliases
|--------------------------------------------------------------------------
|
| This array of class aliases will be registered when this application
| is started. However, feel free to register as many as you wish as
| the aliases are "lazy" loaded so they don't hinder performance.
|
*/
'aliases' => Facade::defaultAliases()->merge([
// 'ExampleClass' => App\Example\ExampleClass::class,
])->toArray(),
];
+---- auth.php
<?php
return [
/*
|--------------------------------------------------------------------------
| Authentication Defaults
|--------------------------------------------------------------------------
|
| This option controls the default authentication "guard" and password
| reset options for your application. You may change these defaults
| as required, but they're a perfect start for most applications.
|
*/
'defaults' => [
'guard' => 'api',
'passwords' => 'users',
],
/*
|--------------------------------------------------------------------------
| Authentication Guards
|--------------------------------------------------------------------------
|
| Next, you may define every authentication guard for your application.
| Of course, a great default configuration has been defined for you
| here which uses session storage and the Eloquent user provider.
|
| All authentication drivers have a user provider. This defines how the
| users are actually retrieved out of your database or other storage
| mechanisms used by this application to persist your user's data.
|
| Supported: "session", "jwt"
|
*/
'guards' => [
'web' => [
'driver' => 'session',
'provider' => 'users',
],
'api' => [
'driver' => 'jwt',
'provider' => 'users',
'input_key' => 'token',
],
],
/*
|--------------------------------------------------------------------------
| User Providers
|--------------------------------------------------------------------------
|
| All authentication drivers have a user provider. This defines how the
| users are actually retrieved out of your database or other storage
| mechanisms used by this application to persist your user's data.
|
| If you have multiple user tables or models you may configure multiple
| sources which represent each model / table. These sources may then
| be assigned to any extra authentication guards you have defined.
|
| Supported: "database", "eloquent"
|
*/
'providers' => [
'users' => [
'driver' => 'eloquent',
'model' => App\Models\User::class,
],
// 'users' => [
// 'driver' => 'database',
// 'table' => 'users',
// ],
],
/*
|--------------------------------------------------------------------------
| Resetting Passwords
|--------------------------------------------------------------------------
|
| You may specify multiple password reset configurations if you have more
| than one user table or model in the application and you want to have
| separate password reset settings based on the specific user types.
|
| The expire time is the number of minutes that each reset token will be
| considered valid. This security feature keeps tokens short-lived so
| they have less time to be guessed. You may change this as needed.
|
*/
'passwords' => [
'users' => [
'provider' => 'users',
'table' => 'password_resets',
'expire' => 60,
'throttle' => 60,
],
],
/*
|--------------------------------------------------------------------------
| Password Confirmation Timeout
|--------------------------------------------------------------------------
|
| Here you may define the amount of seconds before a password confirmation
| times out and the user is prompted to re-enter their password via the
| confirmation screen. By default, the timeout lasts for three hours.
|
*/
'password_timeout' => 10800,
];
+---- broadcasting.php
<?php
return [
/*
|--------------------------------------------------------------------------
| Default Broadcaster
|--------------------------------------------------------------------------
|
| This option controls the default broadcaster that will be used by the
| framework when an event needs to be broadcast. You may set this to
| any of the connections defined in the "connections" array below.
|
| Supported: "pusher", "ably", "redis", "log", "null"
|
*/
'default' => env('BROADCAST_DRIVER', 'null'),
/*
|--------------------------------------------------------------------------
| Broadcast Connections
|--------------------------------------------------------------------------
|
| Here you may define all of the broadcast connections that will be used
| to broadcast events to other systems or over websockets. Samples of
| each available type of connection are provided inside this array.
|
*/
'connections' => [
'pusher' => [
'driver' => 'pusher',
'key' => env('PUSHER_APP_KEY'),
'secret' => env('PUSHER_APP_SECRET'),
'app_id' => env('PUSHER_APP_ID'),
'options' => [
'cluster' => env('PUSHER_APP_CLUSTER'),
'useTLS' => true,
],
'client_options' => [
// Guzzle client options: https://docs.guzzlephp.org/en/stable/request-options.html
],
],
'ably' => [
'driver' => 'ably',
'key' => env('ABLY_KEY'),
],
'redis' => [
'driver' => 'redis',
'connection' => 'default',
],
'log' => [
'driver' => 'log',
],
'null' => [
'driver' => 'null',
],
],
];
+---- cache.php
<?php
use Illuminate\Support\Str;
return [
/*
|--------------------------------------------------------------------------
| Default Cache Store
|--------------------------------------------------------------------------
|
| This option controls the default cache connection that gets used while
| using this caching library. This connection is used when another is
| not explicitly specified when executing a given caching function.
|
*/
'default' => env('CACHE_DRIVER', 'file'),
/*
|--------------------------------------------------------------------------
| Cache Stores
|--------------------------------------------------------------------------
|
| Here you may define all of the cache "stores" for your application as
| well as their drivers. You may even define multiple stores for the
| same cache driver to group types of items stored in your caches.
|
| Supported drivers: "apc", "array", "database", "file",
| "memcached", "redis", "dynamodb", "octane", "null"
|
*/
'stores' => [
'apc' => [
'driver' => 'apc',
],
'array' => [
'driver' => 'array',
'serialize' => false,
],
'database' => [
'driver' => 'database',
'table' => 'cache',
'connection' => null,
'lock_connection' => null,
],
'file' => [
'driver' => 'file',
'path' => storage_path('framework/cache/data'),
],
'memcached' => [
'driver' => 'memcached',
'persistent_id' => env('MEMCACHED_PERSISTENT_ID'),
'sasl' => [
env('MEMCACHED_USERNAME'),
env('MEMCACHED_PASSWORD'),
],
'options' => [
// Memcached::OPT_CONNECT_TIMEOUT => 2000,
],
'servers' => [
[
'host' => env('MEMCACHED_HOST', '127.0.0.1'),
'port' => env('MEMCACHED_PORT', 11211),
'weight' => 100,
],
],
],
'redis' => [
'driver' => 'redis',
'connection' => 'cache',
'lock_connection' => 'default',
],
'dynamodb' => [
'driver' => 'dynamodb',
'key' => env('AWS_ACCESS_KEY_ID'),
'secret' => env('AWS_SECRET_ACCESS_KEY'),
'region' => env('AWS_DEFAULT_REGION', 'us-east-1'),
'table' => env('DYNAMODB_CACHE_TABLE', 'cache'),
'endpoint' => env('DYNAMODB_ENDPOINT'),
],
'octane' => [
'driver' => 'octane',
],
],
/*
|--------------------------------------------------------------------------
| Cache Key Prefix
|--------------------------------------------------------------------------
|
| When utilizing the APC, database, memcached, Redis, or DynamoDB cache
| stores there might be other applications using the same cache. For
| that reason, you may prefix every cache key to avoid collisions.
|
*/
'prefix' => env('CACHE_PREFIX', Str::slug(env('APP_NAME', 'laravel'), '_').'_cache_'),
];
+---- cors.php
<?php
return [
/*
|--------------------------------------------------------------------------
| Cross-Origin Resource Sharing (CORS) Configuration
|--------------------------------------------------------------------------
|
| Here you may configure your settings for cross-origin resource sharing
| or "CORS". This determines what cross-origin operations may execute
| in web browsers. You are free to adjust these settings as needed.
|
| To learn more: https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS
|
*/
'paths' => ['api/*', 'sanctum/csrf-cookie'],
'allowed_methods' => ['*'],
'allowed_origins' => ['*'],
'allowed_origins_patterns' => [],
'allowed_headers' => ['Content-Type', 'X-Requested-With', 'Authorization'],
'exposed_headers' => [],
'max_age' => 864000,
'supports_credentials' => true,
];
+---- database.php
<?php
use Illuminate\Support\Str;
return [
/*
|--------------------------------------------------------------------------
| Default Database Connection Name
|--------------------------------------------------------------------------
|
| Here you may specify which of the database connections below you wish
| to use as your default connection for all database work. Of course
| you may use many connections at once using the Database library.
|
*/
'default' => env('DB_CONNECTION', 'mysql'),
/*
|--------------------------------------------------------------------------
| Database Connections
|--------------------------------------------------------------------------
|
| Here are each of the database connections setup for your application.
| Of course, examples of configuring each database platform that is
| supported by Laravel is shown below to make development simple.
|
|
| All database work in Laravel is done through the PHP PDO facilities
| so make sure you have the driver for your particular database of
| choice installed on your machine before you begin development.
|
*/
'connections' => [
'sqlite' => [
'driver' => 'sqlite',
'url' => env('DATABASE_URL'),
'database' => env('DB_DATABASE', database_path('database.sqlite')),
'prefix' => '',
'foreign_key_constraints' => env('DB_FOREIGN_KEYS', true),
],
'mysql' => [
'driver' => 'mysql',
'url' => env('DATABASE_URL'),
'host' => env('DB_HOST', '127.0.0.1'),
'port' => env('DB_PORT', '3306'),
'database' => env('DB_DATABASE', 'forge'),
'username' => env('DB_USERNAME', 'forge'),
'password' => env('DB_PASSWORD', ''),
'unix_socket' => env('DB_SOCKET', ''),
'charset' => 'utf8mb4',
'collation' => 'utf8mb4_unicode_ci',
'prefix' => '',
'prefix_indexes' => true,
'strict' => true,
'engine' => null,
'options' => extension_loaded('pdo_mysql') ? array_filter([
PDO::MYSQL_ATTR_SSL_CA => env('MYSQL_ATTR_SSL_CA'),
]) : [],
],
'pgsql' => [
'driver' => 'pgsql',
'url' => env('DATABASE_URL'),
'host' => env('DB_HOST', '127.0.0.1'),
'port' => env('DB_PORT', '5432'),
'database' => env('DB_DATABASE', 'forge'),
'username' => env('DB_USERNAME', 'forge'),
'password' => env('DB_PASSWORD', ''),
'charset' => 'utf8',
'prefix' => '',
'prefix_indexes' => true,
'search_path' => 'public',
'sslmode' => 'prefer',
],
'sqlsrv' => [
'driver' => 'sqlsrv',
'url' => env('DATABASE_URL'),
'host' => env('DB_HOST', 'localhost'),
'port' => env('DB_PORT', '1433'),
'database' => env('DB_DATABASE', 'forge'),
'username' => env('DB_USERNAME', 'forge'),
'password' => env('DB_PASSWORD', ''),
'charset' => 'utf8',
'prefix' => '',
'prefix_indexes' => true,
// 'encrypt' => env('DB_ENCRYPT', 'yes'),
// 'trust_server_certificate' => env('DB_TRUST_SERVER_CERTIFICATE', 'true'),
],
],
/*
|--------------------------------------------------------------------------
| Migration Repository Table
|--------------------------------------------------------------------------
|
| This table keeps track of all the migrations that have already run for
| your application. Using this information, we can determine which of
| the migrations on disk haven't actually been run in the database.
|
*/
'migrations' => 'migrations',
/*
|--------------------------------------------------------------------------
| Redis Databases
|--------------------------------------------------------------------------
|
| Redis is an open source, fast, and advanced key-value store that also
| provides a richer body of commands than a typical key-value system
| such as APC or Memcached. Laravel makes it easy to dig right in.
|
*/
'redis' => [
'client' => env('REDIS_CLIENT', 'phpredis'),
'options' => [
'cluster' => env('REDIS_CLUSTER', 'redis'),
'prefix' => env('REDIS_PREFIX', Str::slug(env('APP_NAME', 'laravel'), '_').'_database_'),
],
'default' => [
'url' => env('REDIS_URL'),
'host' => env('REDIS_HOST', '127.0.0.1'),
'username' => env('REDIS_USERNAME'),
'password' => env('REDIS_PASSWORD'),
'port' => env('REDIS_PORT', '6379'),
'database' => env('REDIS_DB', '0'),
],
'cache' => [
'url' => env('REDIS_URL'),
'host' => env('REDIS_HOST', '127.0.0.1'),
'username' => env('REDIS_USERNAME'),
'password' => env('REDIS_PASSWORD'),
'port' => env('REDIS_PORT', '6379'),
'database' => env('REDIS_CACHE_DB', '1'),
],
],
];
+---- filesystems.php
<?php
return [
/*
|--------------------------------------------------------------------------
| Default Filesystem Disk
|--------------------------------------------------------------------------
|
| Here you may specify the default filesystem disk that should be used
| by the framework. The "local" disk, as well as a variety of cloud
| based disks are available to your application. Just store away!
|
*/
'default' => env('FILESYSTEM_DISK', 'local'),
/*
|--------------------------------------------------------------------------
| Filesystem Disks
|--------------------------------------------------------------------------
|
| Here you may configure as many filesystem "disks" as you wish, and you
| may even configure multiple disks of the same driver. Defaults have
| been set up for each driver as an example of the required values.
|
| Supported Drivers: "local", "ftp", "sftp", "s3"
|
*/
'disks' => [
'local' => [
'driver' => 'local',
'root' => storage_path('app'),
'throw' => false,
],
'public' => [
'driver' => 'local',
'root' => storage_path('app/public'),
'url' => env('APP_URL').'/storage',
'visibility' => 'public',
'throw' => false,
],
's3' => [
'driver' => 's3',
'key' => env('AWS_ACCESS_KEY_ID'),
'secret' => env('AWS_SECRET_ACCESS_KEY'),
'region' => env('AWS_DEFAULT_REGION'),
'bucket' => env('AWS_BUCKET'),
'url' => env('AWS_URL'),
'endpoint' => env('AWS_ENDPOINT'),
'use_path_style_endpoint' => env('AWS_USE_PATH_STYLE_ENDPOINT', false),
'throw' => false,
],
],
/*
|--------------------------------------------------------------------------
| Symbolic Links
|--------------------------------------------------------------------------
|
| Here you may configure the symbolic links that will be created when the
| `storage:link` Artisan command is executed. The array keys should be
| the locations of the links and the values should be their targets.
|
*/
'links' => [
public_path('storage') => storage_path('app/public'),
],
];
+---- hashing.php
<?php
return [
/*
|--------------------------------------------------------------------------
| Default Hash Driver
|--------------------------------------------------------------------------
|
| This option controls the default hash driver that will be used to hash
| passwords for your application. By default, the bcrypt algorithm is
| used; however, you remain free to modify this option if you wish.
|
| Supported: "bcrypt", "argon", "argon2id"
|
*/
'driver' => 'bcrypt',
/*
|--------------------------------------------------------------------------
| Bcrypt Options
|--------------------------------------------------------------------------
|
| Here you may specify the configuration options that should be used when
| passwords are hashed using the Bcrypt algorithm. This will allow you
| to control the amount of time it takes to hash the given password.
|
*/
'bcrypt' => [
'rounds' => env('BCRYPT_ROUNDS', 10),
],
/*
|--------------------------------------------------------------------------
| Argon Options
|--------------------------------------------------------------------------
|
| Here you may specify the configuration options that should be used when
| passwords are hashed using the Argon algorithm. These will allow you
| to control the amount of time it takes to hash the given password.
|
*/
'argon' => [
'memory' => 65536,
'threads' => 1,
'time' => 4,
],
];
+---- jwt.php
<?php
return [
/**
* Expiration of JWT Token in seconds.
*/
'expiration' => (int) env('JWT_EXPIRATION', 3600), // one hour
/**
* Default JWT headers.
*/
'headers' => [
'alg' => 'HS256',
'typ' => 'JWT',
],
];
+---- l5-swagger.php
<?php
return [
'default' => 'default',
'documentations' => [
'default' => [
'api' => [
'title' => config('app.name') . ' OpenAPI Documentation',
],
'routes' => [
/*
* Route for accessing api documentation interface
*/
'api' => 'api/documentation',
],
'paths' => [
/*
* File name of the generated json documentation file
*/
'docs_json' => 'api-docs.json',
/*
* File name of the generated YAML documentation file
*/
'docs_yaml' => 'api-docs.yaml',
/*
* Set this to `json` or `yaml` to determine which documentation file to use in UI
*/
'format_to_use_for_docs' => env('L5_FORMAT_TO_USE_FOR_DOCS', 'json'),
/*
* Absolute paths to directory containing the swagger annotations are stored.
*/
'annotations' => [
base_path('app/Annotations/Api'),
base_path('app/Http/Controllers/Api'),
base_path('app/Http/Requests/Api'),
base_path('app/Http/Resources/Api'),
base_path('app/Models'),
],
],
],
],
'defaults' => [
'routes' => [
/*
* Route for accessing parsed swagger annotations.
*/
'docs' => 'docs',
/*
* Route for Oauth2 authentication callback.
*/
'oauth2_callback' => 'api/oauth2-callback',
/*
* Middleware allows to prevent unexpected access to API documentation
*/
'middleware' => [
'api' => [],
'asset' => [],
'docs' => [],
'oauth2_callback' => [],
],
/*
* Route Group options
*/
'group_options' => [],
],
'paths' => [
/*
* Absolute path to location where parsed annotations will be stored
*/
'docs' => storage_path('api-docs'),
/*
* Absolute path to directory where to export views
*/
'views' => base_path('resources/views/vendor/l5-swagger'),
/*
* Edit to set the api's base path
*/
'base' => env('L5_SWAGGER_BASE_PATH', null),
/*
* Edit to set path where swagger ui assets should be stored
*/
'swagger_ui_assets_path' => env('L5_SWAGGER_UI_ASSETS_PATH', 'vendor/swagger-api/swagger-ui/dist/'),
/*
* Absolute path to directories that should be exclude from scanning
* @deprecated Please use `scanOptions.exclude`
* `scanOptions.exclude` overwrites this
*/
'excludes' => [],
],
'scanOptions' => [
/**
* analyser: defaults to \OpenApi\StaticAnalyser .
* @see \OpenApi\scan
*/
'analyser' => null,
/**
* analysis: defaults to a new \OpenApi\Analysis .
* @see \OpenApi\scan
*/
'analysis' => null,
/**
* Custom query path processors classes.
*
* @link https://github.com/zircote/swagger-php/tree/master/Examples/schema-query-parameter-processor
* @see \OpenApi\scan
*/
'processors' => [
// new \App\SwaggerProcessors\SchemaQueryParameter(),
],
/**
* pattern: string $pattern File pattern(s) to scan (default: *.php) .
* @see \OpenApi\scan
*/
'pattern' => null,
/*
* Absolute path to directories that should be exclude from scanning
* @note This option overwrites `paths.excludes`
* @see \OpenApi\scan
*/
'exclude' => [],
],
/*
* API security definitions. Will be generated into documentation file.
*/
'securityDefinitions' => [
'securitySchemes' => [
/*
* Examples of Security schemes
*/
/*
'api_key_security_example' => [ // Unique name of security
'type' => 'apiKey', // The type of the security scheme. Valid values are "basic", "apiKey" or "oauth2".
'description' => 'A short description for security scheme',
'name' => 'api_key', // The name of the header or query parameter to be used.
'in' => 'header', // The location of the API key. Valid values are "query" or "header".
],
'oauth2_security_example' => [ // Unique name of security
'type' => 'oauth2', // The type of the security scheme. Valid values are "basic", "apiKey" or "oauth2".
'description' => 'A short description for oauth2 security scheme.',
'flow' => 'implicit', // The flow used by the OAuth2 security scheme. Valid values are "implicit", "password", "application" or "accessCode".
'authorizationUrl' => 'http://example.com/auth', // The authorization URL to be used for (implicit/accessCode)
//'tokenUrl' => 'http://example.com/auth' // The authorization URL to be used for (password/application/accessCode)
'scopes' => [
'read:projects' => 'read your projects',
'write:projects' => 'modify projects in your account',
]
],
*/
/* Open API 3.0 support
'passport' => [ // Unique name of security
'type' => 'oauth2', // The type of the security scheme. Valid values are "basic", "apiKey" or "oauth2".
'description' => 'Laravel passport oauth2 security.',
'in' => 'header',
'scheme' => 'https',
'flows' => [
"password" => [
"authorizationUrl" => config('app.url') . '/oauth/authorize',
"tokenUrl" => config('app.url') . '/oauth/token',
"refreshUrl" => config('app.url') . '/token/refresh',
"scopes" => []
],
],
],
*/
],
'security' => [
/*
* Examples of Securities
*/
[
/*
'oauth2_security_example' => [
'read',
'write'
],
'passport' => []
*/
],
],
],
/*
* Set this to `true` in development mode so that docs would be regenerated on each request
* Set this to `false` to disable swagger generation on production
*/
'generate_always' => env('L5_SWAGGER_GENERATE_ALWAYS', false),
/*
* Set this to `true` to generate a copy of documentation in yaml format
*/
'generate_yaml_copy' => env('L5_SWAGGER_GENERATE_YAML_COPY', false),
/*
* Edit to trust the proxy's ip address - needed for AWS Load Balancer
* string[]
*/
'proxy' => false,
/*
* Configs plugin allows to fetch external configs instead of passing them to SwaggerUIBundle.
* See more at: https://github.com/swagger-api/swagger-ui#configs-plugin
*/
'additional_config_url' => null,
/*
* Apply a sort to the operation list of each API. It can be 'alpha' (sort by paths alphanumerically),
* 'method' (sort by HTTP method).
* Default is the order returned by the server unchanged.
*/
'operations_sort' => env('L5_SWAGGER_OPERATIONS_SORT', null),
/*
* Pass the validatorUrl parameter to SwaggerUi init on the JS side.
* A null value here disables validation.
*/
'validator_url' => null,
/*
* Persist authorization login after refresh browser
*/
'persist_authorization' => true,
/*
* Uncomment to add constants which can be used in annotations
*/
// 'constants' => [
// 'L5_SWAGGER_CONST_HOST' => env('L5_SWAGGER_CONST_HOST', 'http://my-default-host.com'),
// ],
],
];
+---- logging.php
<?php
use Monolog\Handler\NullHandler;
use Monolog\Handler\StreamHandler;
use Monolog\Handler\SyslogUdpHandler;
return [
/*
|--------------------------------------------------------------------------
| Default Log Channel
|--------------------------------------------------------------------------
|
| This option defines the default log channel that gets used when writing
| messages to the logs. The name specified in this option should match
| one of the channels defined in the "channels" configuration array.
|
*/
'default' => env('LOG_CHANNEL', 'stack'),
/*
|--------------------------------------------------------------------------
| Deprecations Log Channel
|--------------------------------------------------------------------------
|
| This option controls the log channel that should be used to log warnings
| regarding deprecated PHP and library features. This allows you to get
| your application ready for upcoming major versions of dependencies.
|
*/
'deprecations' => env('LOG_DEPRECATIONS_CHANNEL', 'null'),
/*
|--------------------------------------------------------------------------
| Log Channels
|--------------------------------------------------------------------------
|
| Here you may configure the log channels for your application. Out of
| the box, Laravel uses the Monolog PHP logging library. This gives
| you a variety of powerful log handlers / formatters to utilize.
|
| Available Drivers: "single", "daily", "slack", "syslog",
| "errorlog", "monolog",
| "custom", "stack"
|
*/
'channels' => [
'stack' => [
'driver' => 'stack',
'channels' => ['single'],
'ignore_exceptions' => false,
],
'single' => [
'driver' => 'single',
'path' => storage_path('logs/laravel.log'),
'level' => env('LOG_LEVEL', 'debug'),
],
'daily' => [
'driver' => 'daily',
'path' => storage_path('logs/laravel.log'),
'level' => env('LOG_LEVEL', 'debug'),
'days' => 14,
],
'slack' => [
'driver' => 'slack',
'url' => env('LOG_SLACK_WEBHOOK_URL'),
'username' => 'Laravel Log',
'emoji' => ':boom:',
'level' => env('LOG_LEVEL', 'critical'),
],
'papertrail' => [
'driver' => 'monolog',
'level' => env('LOG_LEVEL', 'debug'),
'handler' => env('LOG_PAPERTRAIL_HANDLER', SyslogUdpHandler::class),
'handler_with' => [
'host' => env('PAPERTRAIL_URL'),
'port' => env('PAPERTRAIL_PORT'),
'connectionString' => 'tls://'.env('PAPERTRAIL_URL').':'.env('PAPERTRAIL_PORT'),
],
],
'stderr' => [
'driver' => 'monolog',
'level' => env('LOG_LEVEL', 'debug'),
'handler' => StreamHandler::class,
'formatter' => env('LOG_STDERR_FORMATTER'),
'with' => [
'stream' => 'php://stderr',
],
],
'syslog' => [
'driver' => 'syslog',
'level' => env('LOG_LEVEL', 'debug'),
],
'errorlog' => [
'driver' => 'errorlog',
'level' => env('LOG_LEVEL', 'debug'),
],
'null' => [
'driver' => 'monolog',
'handler' => NullHandler::class,
],
'emergency' => [
'path' => storage_path('logs/laravel.log'),
],
],
];
+---- mail.php
<?php
return [
/*
|--------------------------------------------------------------------------
| Default Mailer
|--------------------------------------------------------------------------
|
| This option controls the default mailer that is used to send any email
| messages sent by your application. Alternative mailers may be setup
| and used as needed; however, this mailer will be used by default.
|
*/
'default' => env('MAIL_MAILER', 'smtp'),
/*
|--------------------------------------------------------------------------
| Mailer Configurations
|--------------------------------------------------------------------------
|
| Here you may configure all of the mailers used by your application plus
| their respective settings. Several examples have been configured for
| you and you are free to add your own as your application requires.
|
| Laravel supports a variety of mail "transport" drivers to be used while
| sending an e-mail. You will specify which one you are using for your
| mailers below. You are free to add additional mailers as required.
|
| Supported: "smtp", "sendmail", "mailgun", "ses",
| "postmark", "log", "array", "failover"
|
*/
'mailers' => [
'smtp' => [
'transport' => 'smtp',
'host' => env('MAIL_HOST', 'smtp.mailgun.org'),
'port' => env('MAIL_PORT', 587),
'encryption' => env('MAIL_ENCRYPTION', 'tls'),
'username' => env('MAIL_USERNAME'),
'password' => env('MAIL_PASSWORD'),
'timeout' => null,
],
'ses' => [
'transport' => 'ses',
],
'mailgun' => [
'transport' => 'mailgun',
],
'postmark' => [
'transport' => 'postmark',
],
'sendmail' => [
'transport' => 'sendmail',
'path' => env('MAIL_SENDMAIL_PATH', '/usr/sbin/sendmail -bs -i'),
],
'log' => [
'transport' => 'log',
'channel' => env('MAIL_LOG_CHANNEL'),
],
'array' => [
'transport' => 'array',
],
'failover' => [
'transport' => 'failover',
'mailers' => [
'smtp',
'log',
],
],
],
/*
|--------------------------------------------------------------------------
| Global "From" Address
|--------------------------------------------------------------------------
|
| You may wish for all e-mails sent by your application to be sent from
| the same address. Here, you may specify a name and address that is
| used globally for all e-mails that are sent by your application.
|
*/
'from' => [
'address' => env('MAIL_FROM_ADDRESS', 'hello@example.com'),
'name' => env('MAIL_FROM_NAME', 'Example'),
],
/*
|--------------------------------------------------------------------------
| Markdown Mail Settings
|--------------------------------------------------------------------------
|
| If you are using Markdown based email rendering, you may configure your
| theme and component paths here, allowing you to customize the design
| of the emails. Or, you may simply stick with the Laravel defaults!
|
*/
'markdown' => [
'theme' => 'default',
'paths' => [
resource_path('views/vendor/mail'),
],
],
];
+---- queue.php
<?php
return [
/*
|--------------------------------------------------------------------------
| Default Queue Connection Name
|--------------------------------------------------------------------------
|
| Laravel's queue API supports an assortment of back-ends via a single
| API, giving you convenient access to each back-end using the same
| syntax for every one. Here you may define a default connection.
|
*/
'default' => env('QUEUE_CONNECTION', 'sync'),
/*
|--------------------------------------------------------------------------
| Queue Connections
|--------------------------------------------------------------------------
|
| Here you may configure the connection information for each server that
| is used by your application. A default configuration has been added
| for each back-end shipped with Laravel. You are free to add more.
|
| Drivers: "sync", "database", "beanstalkd", "sqs", "redis", "null"
|
*/
'connections' => [
'sync' => [
'driver' => 'sync',
],
'database' => [
'driver' => 'database',
'table' => 'jobs',
'queue' => 'default',
'retry_after' => 90,
'after_commit' => false,
],
'beanstalkd' => [
'driver' => 'beanstalkd',
'host' => 'localhost',
'queue' => 'default',
'retry_after' => 90,
'block_for' => 0,
'after_commit' => false,
],
'sqs' => [
'driver' => 'sqs',
'key' => env('AWS_ACCESS_KEY_ID'),
'secret' => env('AWS_SECRET_ACCESS_KEY'),
'prefix' => env('SQS_PREFIX', 'https://sqs.us-east-1.amazonaws.com/your-account-id'),
'queue' => env('SQS_QUEUE', 'default'),
'suffix' => env('SQS_SUFFIX'),
'region' => env('AWS_DEFAULT_REGION', 'us-east-1'),
'after_commit' => false,
],
'redis' => [
'driver' => 'redis',
'connection' => 'default',
'queue' => env('REDIS_QUEUE', 'default'),
'retry_after' => 90,
'block_for' => null,
'after_commit' => false,
],
],
/*
|--------------------------------------------------------------------------
| Failed Queue Jobs
|--------------------------------------------------------------------------
|
| These options configure the behavior of failed queue job logging so you
| can control which database and table are used to store the jobs that
| have failed. You may change them to any database / table you wish.
|
*/
'failed' => [
'driver' => env('QUEUE_FAILED_DRIVER', 'database-uuids'),
'database' => env('DB_CONNECTION', 'mysql'),
'table' => 'failed_jobs',
],
];
+---- sanctum.php
<?php
use Laravel\Sanctum\Sanctum;
return [
/*
|--------------------------------------------------------------------------
| Stateful Domains
|--------------------------------------------------------------------------
|
| Requests from the following domains / hosts will receive stateful API
| authentication cookies. Typically, these should include your local
| and production domains which access your API via a frontend SPA.
|
*/
'stateful' => explode(',', env('SANCTUM_STATEFUL_DOMAINS', sprintf(
'%s%s',
'localhost,localhost:3000,127.0.0.1,127.0.0.1:8000,::1',
Sanctum::currentApplicationUrlWithPort()
))),
/*
|--------------------------------------------------------------------------
| Sanctum Guards
|--------------------------------------------------------------------------
|
| This array contains the authentication guards that will be checked when
| Sanctum is trying to authenticate a request. If none of these guards
| are able to authenticate the request, Sanctum will use the bearer
| token that's present on an incoming request for authentication.
|
*/
'guard' => ['web'],
/*
|--------------------------------------------------------------------------
| Expiration Minutes
|--------------------------------------------------------------------------
|
| This value controls the number of minutes until an issued token will be
| considered expired. If this value is null, personal access tokens do
| not expire. This won't tweak the lifetime of first-party sessions.
|
*/
'expiration' => null,
/*
|--------------------------------------------------------------------------
| Sanctum Middleware
|--------------------------------------------------------------------------
|
| When authenticating your first-party SPA with Sanctum you may need to
| customize some of the middleware Sanctum uses while processing the
| request. You may change the middleware listed below as required.
|
*/
'middleware' => [
'verify_csrf_token' => App\Http\Middleware\VerifyCsrfToken::class,
'encrypt_cookies' => App\Http\Middleware\EncryptCookies::class,
],
];
+---- services.php
<?php
return [
/*
|--------------------------------------------------------------------------
| Third Party Services
|--------------------------------------------------------------------------
|
| This file is for storing the credentials for third party services such
| as Mailgun, Postmark, AWS and more. This file provides the de facto
| location for this type of information, allowing packages to have
| a conventional file to locate the various service credentials.
|
*/
'mailgun' => [
'domain' => env('MAILGUN_DOMAIN'),
'secret' => env('MAILGUN_SECRET'),
'endpoint' => env('MAILGUN_ENDPOINT', 'api.mailgun.net'),
'scheme' => 'https',
],
'postmark' => [
'token' => env('POSTMARK_TOKEN'),
],
'ses' => [
'key' => env('AWS_ACCESS_KEY_ID'),
'secret' => env('AWS_SECRET_ACCESS_KEY'),
'region' => env('AWS_DEFAULT_REGION', 'us-east-1'),
],
];
+---- session.php
<?php
use Illuminate\Support\Str;
return [
/*
|--------------------------------------------------------------------------
| Default Session Driver
|--------------------------------------------------------------------------
|
| This option controls the default session "driver" that will be used on
| requests. By default, we will use the lightweight native driver but
| you may specify any of the other wonderful drivers provided here.
|
| Supported: "file", "cookie", "database", "apc",
| "memcached", "redis", "dynamodb", "array"
|
*/
'driver' => env('SESSION_DRIVER', 'file'),
/*
|--------------------------------------------------------------------------
| Session Lifetime
|--------------------------------------------------------------------------
|
| Here you may specify the number of minutes that you wish the session
| to be allowed to remain idle before it expires. If you want them
| to immediately expire on the browser closing, set that option.
|
*/
'lifetime' => env('SESSION_LIFETIME', 120),
'expire_on_close' => false,
/*
|--------------------------------------------------------------------------
| Session Encryption
|--------------------------------------------------------------------------
|
| This option allows you to easily specify that all of your session data
| should be encrypted before it is stored. All encryption will be run
| automatically by Laravel and you can use the Session like normal.
|
*/
'encrypt' => false,
/*
|--------------------------------------------------------------------------
| Session File Location
|--------------------------------------------------------------------------
|
| When using the native session driver, we need a location where session
| files may be stored. A default has been set for you but a different
| location may be specified. This is only needed for file sessions.
|
*/
'files' => storage_path('framework/sessions'),
/*
|--------------------------------------------------------------------------
| Session Database Connection
|--------------------------------------------------------------------------
|
| When using the "database" or "redis" session drivers, you may specify a
| connection that should be used to manage these sessions. This should
| correspond to a connection in your database configuration options.
|
*/
'connection' => env('SESSION_CONNECTION'),
/*
|--------------------------------------------------------------------------
| Session Database Table
|--------------------------------------------------------------------------
|
| When using the "database" session driver, you may specify the table we
| should use to manage the sessions. Of course, a sensible default is
| provided for you; however, you are free to change this as needed.
|
*/
'table' => 'sessions',
/*
|--------------------------------------------------------------------------
| Session Cache Store
|--------------------------------------------------------------------------
|
| While using one of the framework's cache driven session backends you may
| list a cache store that should be used for these sessions. This value
| must match with one of the application's configured cache "stores".
|
| Affects: "apc", "dynamodb", "memcached", "redis"
|
*/
'store' => env('SESSION_STORE'),
/*
|--------------------------------------------------------------------------
| Session Sweeping Lottery
|--------------------------------------------------------------------------
|
| Some session drivers must manually sweep their storage location to get
| rid of old sessions from storage. Here are the chances that it will
| happen on a given request. By default, the odds are 2 out of 100.
|
*/
'lottery' => [2, 100],
/*
|--------------------------------------------------------------------------
| Session Cookie Name
|--------------------------------------------------------------------------
|
| Here you may change the name of the cookie used to identify a session
| instance by ID. The name specified here will get used every time a
| new session cookie is created by the framework for every driver.
|
*/
'cookie' => env(
'SESSION_COOKIE',
Str::slug(env('APP_NAME', 'laravel'), '_').'_session'
),
/*
|--------------------------------------------------------------------------
| Session Cookie Path
|--------------------------------------------------------------------------
|
| The session cookie path determines the path for which the cookie will
| be regarded as available. Typically, this will be the root path of
| your application but you are free to change this when necessary.
|
*/
'path' => '/',
/*
|--------------------------------------------------------------------------
| Session Cookie Domain
|--------------------------------------------------------------------------
|
| Here you may change the domain of the cookie used to identify a session
| in your application. This will determine which domains the cookie is
| available to in your application. A sensible default has been set.
|
*/
'domain' => env('SESSION_DOMAIN'),
/*
|--------------------------------------------------------------------------
| HTTPS Only Cookies
|--------------------------------------------------------------------------
|
| By setting this option to true, session cookies will only be sent back
| to the server if the browser has a HTTPS connection. This will keep
| the cookie from being sent to you when it can't be done securely.
|
*/
'secure' => env('SESSION_SECURE_COOKIE'),
/*
|--------------------------------------------------------------------------
| HTTP Access Only
|--------------------------------------------------------------------------
|
| Setting this value to true will prevent JavaScript from accessing the
| value of the cookie and the cookie will only be accessible through
| the HTTP protocol. You are free to modify this option if needed.
|
*/
'http_only' => true,
/*
|--------------------------------------------------------------------------
| Same-Site Cookies
|--------------------------------------------------------------------------
|
| This option determines how your cookies behave when cross-site requests
| take place, and can be used to mitigate CSRF attacks. By default, we
| will set this value to "lax" since this is a secure default value.
|
| Supported: "lax", "strict", "none", null
|
*/
'same_site' => 'lax',
];
+---- view.php
<?php
return [
/*
|--------------------------------------------------------------------------
| View Storage Paths
|--------------------------------------------------------------------------
|
| Most templating systems load templates from disk. Here you may specify
| an array of paths that should be checked for your views. Of course
| the usual Laravel view path has already been registered for you.
|
*/
'paths' => [
resource_path('views'),
],
/*
|--------------------------------------------------------------------------
| Compiled View Path
|--------------------------------------------------------------------------
|
| This option determines where all the compiled Blade templates will be
| stored for your application. Typically, this is within the storage
| directory. However, as usual, you are free to change this value.
|
*/
'compiled' => env(
'VIEW_COMPILED_PATH',
realpath(storage_path('framework/views'))
),
];
database
+---- .gitignore
*.sqlite*
+---- factories
| +---- ArticleFactory.php
<?php
namespace Database\Factories;
use App\Models\User;
use Illuminate\Database\Eloquent\Factories\Factory;
use Illuminate\Support\Str;
/**
* @extends \Illuminate\Database\Eloquent\Factories\Factory<\App\Models\Article>
*/
class ArticleFactory extends Factory
{
/**
* Define the model's default state.
*
* @return array<string, mixed>
*/
public function definition()
{
return [
'author_id' => User::factory(),
'slug' => fn (array $attrs) => Str::slug($attrs['title']),
'title' => $this->faker->unique()->sentence(4),
'description' => $this->faker->paragraph(),
'body' => $this->faker->text(),
'created_at' => function (array $attributes) {
$user = User::find($attributes['author_id']);
return $this->faker->dateTimeBetween($user->created_at);
},
'updated_at' => function (array $attributes) {
$createdAt = $attributes['created_at'];
return $this->faker->optional(25, $createdAt)
->dateTimeBetween($createdAt);
},
];
}
}
| +---- CommentFactory.php
<?php
namespace Database\Factories;
use App\Models\Article;
use App\Models\User;
use Illuminate\Database\Eloquent\Factories\Factory;
/**
* @extends \Illuminate\Database\Eloquent\Factories\Factory<\App\Models\Comment>
*/
class CommentFactory extends Factory
{
/**
* Define the model's default state.
*
* @return array<string, mixed>
*/
public function definition()
{
return [
'article_id' => Article::factory(),
'author_id' => User::factory(),
'body' => $this->faker->sentence(),
'created_at' => function (array $attributes) {
$article = Article::find($attributes['article_id']);
return $this->faker->dateTimeBetween($article->created_at);
},
'updated_at' => function (array $attributes) {
return $attributes['created_at'];
},
];
}
}
| +---- TagFactory.php
<?php
namespace Database\Factories;
use Illuminate\Database\Eloquent\Factories\Factory;
/**
* @extends \Illuminate\Database\Eloquent\Factories\Factory<\App\Models\Tag>
*/
class TagFactory extends Factory
{
/**
* Define the model's default state.
*
* @return array<string, mixed>
*/
public function definition()
{
$createdAt = $this->faker->dateTimeThisDecade();
return [
'name' => $this->faker->unique()->word(),
'created_at' => $createdAt,
'updated_at' => $createdAt,
];
}
}
| +---- UserFactory.php
<?php
namespace Database\Factories;
use Illuminate\Database\Eloquent\Factories\Factory;
/**
* @extends \Illuminate\Database\Eloquent\Factories\Factory<\App\Models\User>
*/
class UserFactory extends Factory
{
/**
* Define the model's default state.
*
* @return array<string, mixed>
*/
public function definition()
{
return [
'username' => $this->faker->unique()->userName(),
'email' => $this->faker->unique()->safeEmail(),
'bio' => $this->faker->optional()->paragraph(),
'image' => $this->faker->optional()->imageUrl(),
'password' => '$2y$10$92IXUNpkjO0rOQ5byMi.Ye4oKoEa3Ro9llC/.og/at2.uheWG/igi', // password
'created_at' => $createdAt = $this->faker->dateTimeThisDecade(),
'updated_at' => $this->faker->optional(50, $createdAt)
->dateTimeBetween($createdAt),
];
}
}
+---- migrations
| +---- 2014_10_12_000000_create_users_table.php
<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
return new class extends Migration
{
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
Schema::create('users', function (Blueprint $table) {
$table->id();
$table->string('name')->nullable();
$table->string('email')->unique();
$table->timestamp('email_verified_at')->nullable();
$table->string('password');
$table->rememberToken();
$table->timestamps();
});
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
Schema::dropIfExists('users');
}
};
| +---- 2014_10_12_100000_create_password_resets_table.php
<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
return new class extends Migration
{
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
Schema::create('password_resets', function (Blueprint $table) {
$table->string('email')->index();
$table->string('token');
$table->timestamp('created_at')->nullable();
});
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
Schema::dropIfExists('password_resets');
}
};
| +---- 2019_08_19_000000_create_failed_jobs_table.php
<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
return new class extends Migration
{
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
Schema::create('failed_jobs', function (Blueprint $table) {
$table->id();
$table->string('uuid')->unique();
$table->text('connection');
$table->text('queue');
$table->longText('payload');
$table->longText('exception');
$table->timestamp('failed_at')->useCurrent();
});
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
Schema::dropIfExists('failed_jobs');
}
};
| +---- 2019_12_14_000001_create_personal_access_tokens_table.php
<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
return new class extends Migration
{
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
Schema::create('personal_access_tokens', function (Blueprint $table) {
$table->id();
$table->morphs('tokenable');
$table->string('name');
$table->string('token', 64)->unique();
$table->text('abilities')->nullable();
$table->timestamp('last_used_at')->nullable();
$table->timestamps();
});
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
Schema::dropIfExists('personal_access_tokens');
}
};
| +---- 2021_05_21_130644_add_fields_to_users_table.php
<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
return new class extends Migration
{
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
Schema::table('users', function (Blueprint $table) {
$table->string('username')->unique();
$table->text('bio')->nullable();
$table->text('image')->nullable();
});
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
Schema::table('users', function (Blueprint $table) {
$table->dropColumn(['username', 'bio', 'image']);
});
}
};
| +---- 2021_05_23_123208_create_user_follower_table.php
<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
return new class extends Migration
{
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
Schema::create('author_follower', function (Blueprint $table) {
$table->foreignId('author_id')->constrained('users')->onDelete('cascade');
$table->foreignId('follower_id')->constrained('users')->onDelete('cascade');
$table->unique(['author_id', 'follower_id']);
});
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
Schema::dropIfExists('author_follower');
}
};
| +---- 2021_05_23_150828_create_articles_table.php
<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
return new class extends Migration
{
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
Schema::create('articles', function (Blueprint $table) {
$table->id();
$table->foreignId('author_id')->constrained('users')->onDelete('cascade');
$table->string('slug')->unique();
$table->string('title');
$table->string('description', 510);
$table->text('body');
$table->timestamps();
});
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
Schema::dropIfExists('articles');
}
};
| +---- 2021_05_23_150839_create_comments_table.php
<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
return new class extends Migration
{
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
Schema::create('comments', function (Blueprint $table) {
$table->id();
$table->foreignId('article_id')->constrained('articles')->onDelete('cascade');
$table->foreignId('author_id')->constrained('users')->onDelete('cascade');
$table->text('body');
$table->timestamps();
});
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
Schema::dropIfExists('comments');
}
};
| +---- 2021_05_23_150848_create_tags_table.php
<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
return new class extends Migration
{
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
Schema::create('tags', function (Blueprint $table) {
$table->id();
$table->string('name')->unique();
$table->timestamps();
});
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
Schema::dropIfExists('tags');
}
};
| +---- 2021_05_23_151511_create_article_tag_table.php
<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
return new class extends Migration
{
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
Schema::create('article_tag', function (Blueprint $table) {
$table->foreignId('article_id')->constrained('articles')->onDelete('cascade');
$table->foreignId('tag_id')->constrained('tags')->onDelete('cascade');
$table->unique(['article_id', 'tag_id']);
});
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
Schema::dropIfExists('article_tag');
}
};
| +---- 2021_05_23_152011_create_article_favorite_table.php
<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
return new class extends Migration
{
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
Schema::create('article_favorite', function (Blueprint $table) {
$table->foreignId('article_id')->constrained('articles')->onDelete('cascade');
$table->foreignId('user_id')->constrained('users')->onDelete('cascade');
$table->unique(['article_id', 'user_id']);
});
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
Schema::dropIfExists('article_favorite');
}
};
+---- seeders
| +---- DatabaseSeeder.php
<?php
namespace Database\Seeders;
use App\Models\Article;
use App\Models\Comment;
use App\Models\Tag;
use App\Models\User;
use Illuminate\Database\Eloquent\Factories\Sequence;
use Illuminate\Database\Seeder;
class DatabaseSeeder extends Seeder
{
/**
* Seed the application's database.
*
* @return void
*/
public function run()
{
/** @var array<User>|\Illuminate\Database\Eloquent\Collection<User> $users */
$users = User::factory()->count(20)->create();
foreach ($users as $user) {
$user->followers()->attach($users->random(rand(0, 5)));
}
/** @var array<Article>|\Illuminate\Database\Eloquent\Collection<Article> $articles */
$articles = Article::factory()
->count(30)
->state(new Sequence(fn() => [
'author_id' => $users->random(),
]))
->create();
/** @var array<Tag>|\Illuminate\Database\Eloquent\Collection<Tag> $tags */
$tags = Tag::factory()->count(20)->create();
foreach ($articles as $article) {
$article->tags()->attach($tags->random(rand(0, 6)));
$article->favoredUsers()->attach($users->random(rand(0, 8)));
}
Comment::factory()
->count(60)
->state(new Sequence(fn() => [
'article_id' => $articles->random(),
'author_id' => $users->random(),
]))
->create();
}
}
docker-compose.yml
# For more information: https://laravel.com/docs/sail
version: '3.9'
services:
laravel.test:
build:
context: ./vendor/laravel/sail/runtimes/8.1
dockerfile: Dockerfile
args:
WWWGROUP: '${WWWGROUP}'
image: sail-8.1/app
extra_hosts:
- 'host.docker.internal:host-gateway'
ports:
- '${APP_PORT:-80}:80'
environment:
PHP_IDE_CONFIG: 'serverName=laravel-realworld.test'
WWWUSER: '${WWWUSER}'
LARAVEL_SAIL: 1
XDEBUG_MODE: '${SAIL_XDEBUG_MODE:-off}'
XDEBUG_CONFIG: '${SAIL_XDEBUG_CONFIG:-client_host=host.docker.internal}'
volumes:
- '.:/var/www/html'
networks:
- sail
depends_on:
- pgsql
pgsql:
image: 'postgres:alpine'
ports:
- '${FORWARD_DB_PORT:-5432}:5432'
environment:
PGPASSWORD: '${DB_PASSWORD:-secret}'
POSTGRES_DB: '${DB_DATABASE}'
POSTGRES_USER: '${DB_USERNAME}'
POSTGRES_PASSWORD: '${DB_PASSWORD:-secret}'
volumes:
- 'sail-pgsql:/var/lib/postgresql/data'
networks:
- sail
healthcheck:
test: [ "CMD", "pg_isready", "-q" ]
retries: 3
timeout: 5s
networks:
sail:
name: laravel-realworld-network
driver: bridge
volumes:
sail-pgsql:
name: laravel-realworld-database
driver: local
lang
+---- en
| +---- auth.php
<?php
return [
/*
|--------------------------------------------------------------------------
| Authentication Language Lines
|--------------------------------------------------------------------------
|
| The following language lines are used during authentication for various
| messages that we need to display to the user. You are free to modify
| these language lines according to your application's requirements.
|
*/
'failed' => 'These credentials do not match our records.',
'password' => 'The provided password is incorrect.',
'throttle' => 'Too many login attempts. Please try again in :seconds seconds.',
];
| +---- models.php
<?php
return [
/*
|--------------------------------------------------------------------------
| Model Language Lines
|--------------------------------------------------------------------------
|
| The following language lines contain custom messages related to model.
|
*/
'resource' => [
'404' => 'Resource not found.',
],
'article' => [
'deleted' => 'Article deleted.',
],
'comment' => [
'deleted' => 'Comment deleted.',
],
];
| +---- pagination.php
<?php
return [
/*
|--------------------------------------------------------------------------
| Pagination Language Lines
|--------------------------------------------------------------------------
|
| The following language lines are used by the paginator library to build
| the simple pagination links. You are free to change them to anything
| you want to customize your views to better match your application.
|
*/
'previous' => '« Previous',
'next' => 'Next »',
];
| +---- passwords.php
<?php
return [
/*
|--------------------------------------------------------------------------
| Password Reset Language Lines
|--------------------------------------------------------------------------
|
| The following language lines are the default lines which match reasons
| that are given by the password broker for a password update attempt
| has failed, such as for an invalid token or invalid new password.
|
*/
'reset' => 'Your password has been reset!',
'sent' => 'We have emailed your password reset link!',
'throttled' => 'Please wait before retrying.',
'token' => 'This password reset token is invalid.',
'user' => "We can't find a user with that email address.",
];
| +---- validation.php
<?php
return [
/*
|--------------------------------------------------------------------------
| Validation Language Lines
|--------------------------------------------------------------------------
|
| The following language lines contain the default error messages used by
| the validator class. Some of these rules have multiple versions such
| as the size rules. Feel free to tweak each of these messages here.
|
*/
'accepted' => 'The :attribute must be accepted.',
'accepted_if' => 'The :attribute must be accepted when :other is :value.',
'active_url' => 'The :attribute is not a valid URL.',
'after' => 'The :attribute must be a date after :date.',
'after_or_equal' => 'The :attribute must be a date after or equal to :date.',
'alpha' => 'The :attribute must only contain letters.',
'alpha_dash' => 'The :attribute must only contain letters, numbers, dashes and underscores.',
'alpha_num' => 'The :attribute must only contain letters and numbers.',
'array' => 'The :attribute must be an array.',
'before' => 'The :attribute must be a date before :date.',
'before_or_equal' => 'The :attribute must be a date before or equal to :date.',
'between' => [
'array' => 'The :attribute must have between :min and :max items.',
'file' => 'The :attribute must be between :min and :max kilobytes.',
'numeric' => 'The :attribute must be between :min and :max.',
'string' => 'The :attribute must be between :min and :max characters.',
],
'boolean' => 'The :attribute field must be true or false.',
'confirmed' => 'The :attribute confirmation does not match.',
'current_password' => 'The password is incorrect.',
'date' => 'The :attribute is not a valid date.',
'date_equals' => 'The :attribute must be a date equal to :date.',
'date_format' => 'The :attribute does not match the format :format.',
'declined' => 'The :attribute must be declined.',
'declined_if' => 'The :attribute must be declined when :other is :value.',
'different' => 'The :attribute and :other must be different.',
'digits' => 'The :attribute must be :digits digits.',
'digits_between' => 'The :attribute must be between :min and :max digits.',
'dimensions' => 'The :attribute has invalid image dimensions.',
'distinct' => 'The :attribute field has a duplicate value.',
'email' => 'The :attribute must be a valid email address.',
'ends_with' => 'The :attribute must end with one of the following: :values.',
'enum' => 'The selected :attribute is invalid.',
'exists' => 'The selected :attribute is invalid.',
'file' => 'The :attribute must be a file.',
'filled' => 'The :attribute field must have a value.',
'gt' => [
'array' => 'The :attribute must have more than :value items.',
'file' => 'The :attribute must be greater than :value kilobytes.',
'numeric' => 'The :attribute must be greater than :value.',
'string' => 'The :attribute must be greater than :value characters.',
],
'gte' => [
'array' => 'The :attribute must have :value items or more.',
'file' => 'The :attribute must be greater than or equal to :value kilobytes.',
'numeric' => 'The :attribute must be greater than or equal to :value.',
'string' => 'The :attribute must be greater than or equal to :value characters.',
],
'image' => 'The :attribute must be an image.',
'in' => 'The selected :attribute is invalid.',
'in_array' => 'The :attribute field does not exist in :other.',
'integer' => 'The :attribute must be an integer.',
'ip' => 'The :attribute must be a valid IP address.',
'ipv4' => 'The :attribute must be a valid IPv4 address.',
'ipv6' => 'The :attribute must be a valid IPv6 address.',
'json' => 'The :attribute must be a valid JSON string.',
'lt' => [
'array' => 'The :attribute must have less than :value items.',
'file' => 'The :attribute must be less than :value kilobytes.',
'numeric' => 'The :attribute must be less than :value.',
'string' => 'The :attribute must be less than :value characters.',
],
'lte' => [
'array' => 'The :attribute must not have more than :value items.',
'file' => 'The :attribute must be less than or equal to :value kilobytes.',
'numeric' => 'The :attribute must be less than or equal to :value.',
'string' => 'The :attribute must be less than or equal to :value characters.',
],
'mac_address' => 'The :attribute must be a valid MAC address.',
'max' => [
'array' => 'The :attribute must not have more than :max items.',
'file' => 'The :attribute must not be greater than :max kilobytes.',
'numeric' => 'The :attribute must not be greater than :max.',
'string' => 'The :attribute must not be greater than :max characters.',
],
'mimes' => 'The :attribute must be a file of type: :values.',
'mimetypes' => 'The :attribute must be a file of type: :values.',
'min' => [
'array' => 'The :attribute must have at least :min items.',
'file' => 'The :attribute must be at least :min kilobytes.',
'numeric' => 'The :attribute must be at least :min.',
'string' => 'The :attribute must be at least :min characters.',
],
'multiple_of' => 'The :attribute must be a multiple of :value.',
'not_in' => 'The selected :attribute is invalid.',
'not_regex' => 'The :attribute format is invalid.',
'numeric' => 'The :attribute must be a number.',
'present' => 'The :attribute field must be present.',
'prohibited' => 'The :attribute field is prohibited.',
'prohibited_if' => 'The :attribute field is prohibited when :other is :value.',
'prohibited_unless' => 'The :attribute field is prohibited unless :other is in :values.',
'prohibits' => 'The :attribute field prohibits :other from being present.',
'regex' => 'The :attribute format is invalid.',
'required' => 'The :attribute field is required.',
'required_array_keys' => 'The :attribute field must contain entries for: :values.',
'required_if' => 'The :attribute field is required when :other is :value.',
'required_unless' => 'The :attribute field is required unless :other is in :values.',
'required_with' => 'The :attribute field is required when :values is present.',
'required_with_all' => 'The :attribute field is required when :values are present.',
'required_without' => 'The :attribute field is required when :values is not present.',
'required_without_all' => 'The :attribute field is required when none of :values are present.',
'same' => 'The :attribute and :other must match.',
'size' => [
'array' => 'The :attribute must contain :size items.',
'file' => 'The :attribute must be :size kilobytes.',
'numeric' => 'The :attribute must be :size.',
'string' => 'The :attribute must be :size characters.',
],
'starts_with' => 'The :attribute must start with one of the following: :values.',
'string' => 'The :attribute must be a string.',
'timezone' => 'The :attribute must be a valid timezone.',
'unique' => 'The :attribute has already been taken.',
'uploaded' => 'The :attribute failed to upload.',
'url' => 'The :attribute must be a valid URL.',
'uuid' => 'The :attribute must be a valid UUID.',
'required_at_least_one' => 'At least one field must be present.',
'invalid' => 'The given data was invalid.',
/*
|--------------------------------------------------------------------------
| Custom Validation Language Lines
|--------------------------------------------------------------------------
|
| Here you may specify custom validation messages for attributes using the
| convention "attribute.rule" to name the lines. This makes it quick to
| specify a specific custom language line for a given attribute rule.
|
*/
'custom' => [
'attribute-name' => [
'rule-name' => 'custom-message',
],
],
/*
|--------------------------------------------------------------------------
| Custom Validation Attributes
|--------------------------------------------------------------------------
|
| The following language lines are used to swap our attribute placeholder
| with something more reader friendly such as "E-Mail Address" instead
| of "email". This simply helps us make our message more expressive.
|
*/
'attributes' => [],
];
+---- en.json
{
"The :attribute must contain at least one letter.": "The :attribute must contain at least one letter.",
"The :attribute must contain at least one number.": "The :attribute must contain at least one number.",
"The :attribute must contain at least one symbol.": "The :attribute must contain at least one symbol.",
"The :attribute must contain at least one uppercase and one lowercase letter.": "The :attribute must contain at least one uppercase and one lowercase letter.",
"The given :attribute has appeared in a data leak. Please choose a different :attribute.": "The given :attribute has appeared in a data leak. Please choose a different :attribute."
}
package.json
{
"private": true,
"scripts": {
"dev": "npm run development",
"development": "mix",
"watch": "mix watch",
"watch-poll": "mix watch -- --watch-options-poll=1000",
"hot": "mix watch --hot",
"prod": "npm run production",
"production": "mix --production"
},
"devDependencies": {
"axios": "^0.25",
"laravel-mix": "^6.0.6",
"lodash": "^4.17.19",
"postcss": "^8.1.14"
}
}
phpunit.xml
<?xml version="1.0" encoding="UTF-8"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="./vendor/phpunit/phpunit/phpunit.xsd"
bootstrap="vendor/autoload.php"
colors="true"
failOnRisky="true"
>
<testsuites>
<testsuite name="Unit">
<directory suffix="Test.php">./tests/Unit</directory>
</testsuite>
<testsuite name="Feature">
<directory suffix="Test.php">./tests/Feature</directory>
</testsuite>
</testsuites>
<coverage processUncoveredFiles="true">
<include>
<directory suffix=".php">./app</directory>
</include>
<exclude>
<directory suffix=".php">./app/Providers</directory>
<directory suffix=".php">./app/Http/Middleware</directory>
</exclude>
</coverage>
<php>
<env name="APP_ENV" value="testing"/>
<env name="BCRYPT_ROUNDS" value="4"/>
<env name="CACHE_DRIVER" value="array"/>
<!-- <env name="DB_CONNECTION" value="sqlite"/> -->
<!-- <env name="DB_DATABASE" value=":memory:"/> -->
<env name="MAIL_MAILER" value="array"/>
<env name="QUEUE_CONNECTION" value="sync"/>
<env name="SESSION_DRIVER" value="array"/>
<env name="TELESCOPE_ENABLED" value="false"/>
</php>
</phpunit>
public
+---- index.php
<?php
use Illuminate\Contracts\Http\Kernel;
use Illuminate\Http\Request;
define('LARAVEL_START', microtime(true));
/*
|--------------------------------------------------------------------------
| Check If The Application Is Under Maintenance
|--------------------------------------------------------------------------
|
| If the application is in maintenance / demo mode via the "down" command
| we will load this file so that any pre-rendered content can be shown
| instead of starting the framework, which could cause an exception.
|
*/
if (file_exists($maintenance = __DIR__.'/../storage/framework/maintenance.php')) {
require $maintenance;
}
/*
|--------------------------------------------------------------------------
| Register The Auto Loader
|--------------------------------------------------------------------------
|
| Composer provides a convenient, automatically generated class loader for
| this application. We just need to utilize it! We'll simply require it
| into the script here so we don't need to manually load our classes.
|
*/
require __DIR__.'/../vendor/autoload.php';
/*
|--------------------------------------------------------------------------
| Run The Application
|--------------------------------------------------------------------------
|
| Once we have the application, we can handle the incoming request using
| the application's HTTP kernel. Then, we will send the response back
| to this client's browser, allowing them to enjoy our application.
|
*/
$app = require_once __DIR__.'/../bootstrap/app.php';
$kernel = $app->make(Kernel::class);
$response = $kernel->handle(
$request = Request::capture()
)->send();
$kernel->terminate($request, $response);
+---- robots.txt
User-agent: *
Disallow:
resources
+---- css
| +---- app.css
+---- js
| +---- app.js
require('./bootstrap');
| +---- bootstrap.js
window._ = require('lodash');
/**
* We'll load the axios HTTP library which allows us to easily issue requests
* to our Laravel back-end. This library automatically handles sending the
* CSRF token as a header based on the value of the "XSRF" token cookie.
*/
window.axios = require('axios');
window.axios.defaults.headers.common['X-Requested-With'] = 'XMLHttpRequest';
/**
* Echo exposes an expressive API for subscribing to channels and listening
* for events that are broadcast by Laravel. Echo and event broadcasting
* allows your team to easily build robust real-time web applications.
*/
// import Echo from 'laravel-echo';
// window.Pusher = require('pusher-js');
// window.Echo = new Echo({
// broadcaster: 'pusher',
// key: process.env.MIX_PUSHER_APP_KEY,
// cluster: process.env.MIX_PUSHER_APP_CLUSTER,
// forceTLS: true
// });
+---- views
| +---- vendor
| +---- l5-swagger
| +---- index.blade.php
<!-- HTML for static distribution bundle build -->
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>{{config('l5-swagger.documentations.'.$documentation.'.api.title')}}</title>
<link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700|Source+Code+Pro:300,600|Titillium+Web:400,600,700" rel="stylesheet">
<link rel="stylesheet" type="text/css" href="{{ l5_swagger_asset($documentation, 'swagger-ui.css') }}" >
<link rel="icon" type="image/png" href="{{ l5_swagger_asset($documentation, 'favicon-32x32.png') }}" sizes="32x32" />
<link rel="icon" type="image/png" href="{{ l5_swagger_asset($documentation, 'favicon-16x16.png') }}" sizes="16x16" />
<style>
html
{
box-sizing: border-box;
overflow: -moz-scrollbars-vertical;
overflow-y: scroll;
}
*,
*:before,
*:after
{
box-sizing: inherit;
}
body {
margin:0;
background: #fafafa;
}
</style>
</head>
<body>
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="position:absolute;width:0;height:0">
<defs>
<symbol viewBox="0 0 20 20" id="unlocked">
<path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V6h2v-.801C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8z"></path>
</symbol>
<symbol viewBox="0 0 20 20" id="locked">
<path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8zM12 8H8V5.199C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8z"/>
</symbol>
<symbol viewBox="0 0 20 20" id="close">
<path d="M14.348 14.849c-.469.469-1.229.469-1.697 0L10 11.819l-2.651 3.029c-.469.469-1.229.469-1.697 0-.469-.469-.469-1.229 0-1.697l2.758-3.15-2.759-3.152c-.469-.469-.469-1.228 0-1.697.469-.469 1.228-.469 1.697 0L10 8.183l2.651-3.031c.469-.469 1.228-.469 1.697 0 .469.469.469 1.229 0 1.697l-2.758 3.152 2.758 3.15c.469.469.469 1.229 0 1.698z"/>
</symbol>
<symbol viewBox="0 0 20 20" id="large-arrow">
<path d="M13.25 10L6.109 2.58c-.268-.27-.268-.707 0-.979.268-.27.701-.27.969 0l7.83 7.908c.268.271.268.709 0 .979l-7.83 7.908c-.268.271-.701.27-.969 0-.268-.269-.268-.707 0-.979L13.25 10z"/>
</symbol>
<symbol viewBox="0 0 20 20" id="large-arrow-down">
<path d="M17.418 6.109c.272-.268.709-.268.979 0s.271.701 0 .969l-7.908 7.83c-.27.268-.707.268-.979 0l-7.908-7.83c-.27-.268-.27-.701 0-.969.271-.268.709-.268.979 0L10 13.25l7.418-7.141z"/>
</symbol>
<symbol viewBox="0 0 24 24" id="jump-to">
<path d="M19 7v4H5.83l3.58-3.59L8 6l-6 6 6 6 1.41-1.41L5.83 13H21V7z"/>
</symbol>
<symbol viewBox="0 0 24 24" id="expand">
<path d="M10 18h4v-2h-4v2zM3 6v2h18V6H3zm3 7h12v-2H6v2z"/>
</symbol>
</defs>
</svg>
<div id="swagger-ui"></div>
<script src="{{ l5_swagger_asset($documentation, 'swagger-ui-bundle.js') }}"> </script>
<script src="{{ l5_swagger_asset($documentation, 'swagger-ui-standalone-preset.js') }}"> </script>
<script>
window.onload = function() {
// Build a system
const ui = SwaggerUIBundle({
dom_id: '#swagger-ui',
url: "{!! $urlToDocs !!}",
operationsSorter: {!! isset($operationsSorter) ? '"' . $operationsSorter . '"' : 'null' !!},
configUrl: {!! isset($configUrl) ? '"' . $configUrl . '"' : 'null' !!},
validatorUrl: {!! isset($validatorUrl) ? '"' . $validatorUrl . '"' : 'null' !!},
oauth2RedirectUrl: "{{ route('l5-swagger.'.$documentation.'.oauth2_callback') }}",
requestInterceptor: function(request) {
request.headers['X-CSRF-TOKEN'] = '{{ csrf_token() }}';
return request;
},
presets: [
SwaggerUIBundle.presets.apis,
SwaggerUIStandalonePreset
],
plugins: [
SwaggerUIBundle.plugins.DownloadUrl
],
layout: "StandaloneLayout",
persistAuthorization: {!! config('l5-swagger.defaults.persist_authorization') ? 'true' : 'false' !!},
})
window.ui = ui
}
</script>
</body>
</html>
| +---- welcome.blade.php
<!DOCTYPE html>
<html lang="{{ str_replace('_', '-', app()->getLocale()) }}">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Laravel</title>
<!-- Fonts -->
<link href="https://fonts.googleapis.com/css2?family=Nunito:wght@400;600;700&display=swap" rel="stylesheet">
<!-- Styles -->
<style>
/*! normalize.css v8.0.1 | MIT License | github.com/necolas/normalize.css */html{line-height:1.15;-webkit-text-size-adjust:100%}body{margin:0}a{background-color:transparent}[hidden]{display:none}html{font-family:system-ui,-apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Helvetica Neue,Arial,Noto Sans,sans-serif,Apple Color Emoji,Segoe UI Emoji,Segoe UI Symbol,Noto Color Emoji;line-height:1.5}*,:after,:before{box-sizing:border-box;border:0 solid #e2e8f0}a{color:inherit;text-decoration:inherit}svg,video{display:block;vertical-align:middle}video{max-width:100%;height:auto}.bg-white{--bg-opacity:1;background-color:#fff;background-color:rgba(255,255,255,var(--bg-opacity))}.bg-gray-100{--bg-opacity:1;background-color:#f7fafc;background-color:rgba(247,250,252,var(--bg-opacity))}.border-gray-200{--border-opacity:1;border-color:#edf2f7;border-color:rgba(237,242,247,var(--border-opacity))}.border-t{border-top-width:1px}.flex{display:flex}.grid{display:grid}.hidden{display:none}.items-center{align-items:center}.justify-center{justify-content:center}.font-semibold{font-weight:600}.h-5{height:1.25rem}.h-8{height:2rem}.h-16{height:4rem}.text-sm{font-size:.875rem}.text-lg{font-size:1.125rem}.leading-7{line-height:1.75rem}.mx-auto{margin-left:auto;margin-right:auto}.ml-1{margin-left:.25rem}.mt-2{margin-top:.5rem}.mr-2{margin-right:.5rem}.ml-2{margin-left:.5rem}.mt-4{margin-top:1rem}.ml-4{margin-left:1rem}.mt-8{margin-top:2rem}.ml-12{margin-left:3rem}.-mt-px{margin-top:-1px}.max-w-6xl{max-width:72rem}.min-h-screen{min-height:100vh}.overflow-hidden{overflow:hidden}.p-6{padding:1.5rem}.py-4{padding-top:1rem;padding-bottom:1rem}.px-6{padding-left:1.5rem;padding-right:1.5rem}.pt-8{padding-top:2rem}.fixed{position:fixed}.relative{position:relative}.top-0{top:0}.right-0{right:0}.shadow{box-shadow:0 1px 3px 0 rgba(0,0,0,.1),0 1px 2px 0 rgba(0,0,0,.06)}.text-center{text-align:center}.text-gray-200{--text-opacity:1;color:#edf2f7;color:rgba(237,242,247,var(--text-opacity))}.text-gray-300{--text-opacity:1;color:#e2e8f0;color:rgba(226,232,240,var(--text-opacity))}.text-gray-400{--text-opacity:1;color:#cbd5e0;color:rgba(203,213,224,var(--text-opacity))}.text-gray-500{--text-opacity:1;color:#a0aec0;color:rgba(160,174,192,var(--text-opacity))}.text-gray-600{--text-opacity:1;color:#718096;color:rgba(113,128,150,var(--text-opacity))}.text-gray-700{--text-opacity:1;color:#4a5568;color:rgba(74,85,104,var(--text-opacity))}.text-gray-900{--text-opacity:1;color:#1a202c;color:rgba(26,32,44,var(--text-opacity))}.underline{text-decoration:underline}.antialiased{-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.w-5{width:1.25rem}.w-8{width:2rem}.w-auto{width:auto}.grid-cols-1{grid-template-columns:repeat(1,minmax(0,1fr))}@media (min-width:640px){.sm\:rounded-lg{border-radius:.5rem}.sm\:block{display:block}.sm\:items-center{align-items:center}.sm\:justify-start{justify-content:flex-start}.sm\:justify-between{justify-content:space-between}.sm\:h-20{height:5rem}.sm\:ml-0{margin-left:0}.sm\:px-6{padding-left:1.5rem;padding-right:1.5rem}.sm\:pt-0{padding-top:0}.sm\:text-left{text-align:left}.sm\:text-right{text-align:right}}@media (min-width:768px){.md\:border-t-0{border-top-width:0}.md\:border-l{border-left-width:1px}.md\:grid-cols-2{grid-template-columns:repeat(2,minmax(0,1fr))}}@media (min-width:1024px){.lg\:px-8{padding-left:2rem;padding-right:2rem}}@media (prefers-color-scheme:dark){.dark\:bg-gray-800{--bg-opacity:1;background-color:#2d3748;background-color:rgba(45,55,72,var(--bg-opacity))}.dark\:bg-gray-900{--bg-opacity:1;background-color:#1a202c;background-color:rgba(26,32,44,var(--bg-opacity))}.dark\:border-gray-700{--border-opacity:1;border-color:#4a5568;border-color:rgba(74,85,104,var(--border-opacity))}.dark\:text-white{--text-opacity:1;color:#fff;color:rgba(255,255,255,var(--text-opacity))}.dark\:text-gray-400{--text-opacity:1;color:#cbd5e0;color:rgba(203,213,224,var(--text-opacity))}.dark\:text-gray-500{--tw-text-opacity:1;color:#6b7280;color:rgba(107,114,128,var(--tw-text-opacity))}}
</style>
<style>
body {
font-family: 'Nunito', sans-serif;
}
</style>
</head>
<body class="antialiased">
<div class="relative flex items-top justify-center min-h-screen bg-gray-100 dark:bg-gray-900 sm:items-center py-4 sm:pt-0">
@if (Route::has('login'))
<div class="hidden fixed top-0 right-0 px-6 py-4 sm:block">
@auth
<a href="{{ url('/home') }}" class="text-sm text-gray-700 dark:text-gray-500 underline">Home</a>
@else
<a href="{{ route('login') }}" class="text-sm text-gray-700 dark:text-gray-500 underline">Log in</a>
@if (Route::has('register'))
<a href="{{ route('register') }}" class="ml-4 text-sm text-gray-700 dark:text-gray-500 underline">Register</a>
@endif
@endauth
</div>
@endif
<div class="max-w-6xl mx-auto sm:px-6 lg:px-8">
<div class="flex justify-center pt-8 sm:justify-start sm:pt-0">
<svg viewBox="0 0 651 192" fill="none" xmlns="http://www.w3.org/2000/svg" class="h-16 w-auto text-gray-700 sm:h-20">
<g clip-path="url(#clip0)" fill="#EF3B2D">
<path d="M248.032 44.676h-16.466v100.23h47.394v-14.748h-30.928V44.676zM337.091 87.202c-2.101-3.341-5.083-5.965-8.949-7.875-3.865-1.909-7.756-2.864-11.669-2.864-5.062 0-9.69.931-13.89 2.792-4.201 1.861-7.804 4.417-10.811 7.661-3.007 3.246-5.347 6.993-7.016 11.239-1.672 4.249-2.506 8.713-2.506 13.389 0 4.774.834 9.26 2.506 13.459 1.669 4.202 4.009 7.925 7.016 11.169 3.007 3.246 6.609 5.799 10.811 7.66 4.199 1.861 8.828 2.792 13.89 2.792 3.913 0 7.804-.955 11.669-2.863 3.866-1.908 6.849-4.533 8.949-7.875v9.021h15.607V78.182h-15.607v9.02zm-1.431 32.503c-.955 2.578-2.291 4.821-4.009 6.73-1.719 1.91-3.795 3.437-6.229 4.582-2.435 1.146-5.133 1.718-8.091 1.718-2.96 0-5.633-.572-8.019-1.718-2.387-1.146-4.438-2.672-6.156-4.582-1.719-1.909-3.032-4.152-3.938-6.73-.909-2.577-1.36-5.298-1.36-8.161 0-2.864.451-5.585 1.36-8.162.905-2.577 2.219-4.819 3.938-6.729 1.718-1.908 3.77-3.437 6.156-4.582 2.386-1.146 5.059-1.718 8.019-1.718 2.958 0 5.656.572 8.091 1.718 2.434 1.146 4.51 2.674 6.229 4.582 1.718 1.91 3.054 4.152 4.009 6.729.953 2.577 1.432 5.298 1.432 8.162-.001 2.863-.479 5.584-1.432 8.161zM463.954 87.202c-2.101-3.341-5.083-5.965-8.949-7.875-3.865-1.909-7.756-2.864-11.669-2.864-5.062 0-9.69.931-13.89 2.792-4.201 1.861-7.804 4.417-10.811 7.661-3.007 3.246-5.347 6.993-7.016 11.239-1.672 4.249-2.506 8.713-2.506 13.389 0 4.774.834 9.26 2.506 13.459 1.669 4.202 4.009 7.925 7.016 11.169 3.007 3.246 6.609 5.799 10.811 7.66 4.199 1.861 8.828 2.792 13.89 2.792 3.913 0 7.804-.955 11.669-2.863 3.866-1.908 6.849-4.533 8.949-7.875v9.021h15.607V78.182h-15.607v9.02zm-1.432 32.503c-.955 2.578-2.291 4.821-4.009 6.73-1.719 1.91-3.795 3.437-6.229 4.582-2.435 1.146-5.133 1.718-8.091 1.718-2.96 0-5.633-.572-8.019-1.718-2.387-1.146-4.438-2.672-6.156-4.582-1.719-1.909-3.032-4.152-3.938-6.73-.909-2.577-1.36-5.298-1.36-8.161 0-2.864.451-5.585 1.36-8.162.905-2.577 2.219-4.819 3.938-6.729 1.718-1.908 3.77-3.437 6.156-4.582 2.386-1.146 5.059-1.718 8.019-1.718 2.958 0 5.656.572 8.091 1.718 2.434 1.146 4.51 2.674 6.229 4.582 1.718 1.91 3.054 4.152 4.009 6.729.953 2.577 1.432 5.298 1.432 8.162 0 2.863-.479 5.584-1.432 8.161zM650.772 44.676h-15.606v100.23h15.606V44.676zM365.013 144.906h15.607V93.538h26.776V78.182h-42.383v66.724zM542.133 78.182l-19.616 51.096-19.616-51.096h-15.808l25.617 66.724h19.614l25.617-66.724h-15.808zM591.98 76.466c-19.112 0-34.239 15.706-34.239 35.079 0 21.416 14.641 35.079 36.239 35.079 12.088 0 19.806-4.622 29.234-14.688l-10.544-8.158c-.006.008-7.958 10.449-19.832 10.449-13.802 0-19.612-11.127-19.612-16.884h51.777c2.72-22.043-11.772-40.877-33.023-40.877zm-18.713 29.28c.12-1.284 1.917-16.884 18.589-16.884 16.671 0 18.697 15.598 18.813 16.884h-37.402zM184.068 43.892c-.024-.088-.073-.165-.104-.25-.058-.157-.108-.316-.191-.46-.056-.097-.137-.176-.203-.265-.087-.117-.161-.242-.265-.345-.085-.086-.194-.148-.29-.223-.109-.085-.206-.182-.327-.252l-.002-.001-.002-.002-35.648-20.524a2.971 2.971 0 00-2.964 0l-35.647 20.522-.002.002-.002.001c-.121.07-.219.167-.327.252-.096.075-.205.138-.29.223-.103.103-.178.228-.265.345-.066.089-.147.169-.203.265-.083.144-.133.304-.191.46-.031.085-.08.162-.104.25-.067.249-.103.51-.103.776v38.979l-29.706 17.103V24.493a3 3 0 00-.103-.776c-.024-.088-.073-.165-.104-.25-.058-.157-.108-.316-.191-.46-.056-.097-.137-.176-.203-.265-.087-.117-.161-.242-.265-.345-.085-.086-.194-.148-.29-.223-.109-.085-.206-.182-.327-.252l-.002-.001-.002-.002L40.098 1.396a2.971 2.971 0 00-2.964 0L1.487 21.919l-.002.002-.002.001c-.121.07-.219.167-.327.252-.096.075-.205.138-.29.223-.103.103-.178.228-.265.345-.066.089-.147.169-.203.265-.083.144-.133.304-.191.46-.031.085-.08.162-.104.25-.067.249-.103.51-.103.776v122.09c0 1.063.568 2.044 1.489 2.575l71.293 41.045c.156.089.324.143.49.202.078.028.15.074.23.095a2.98 2.98 0 001.524 0c.069-.018.132-.059.2-.083.176-.061.354-.119.519-.214l71.293-41.045a2.971 2.971 0 001.489-2.575v-38.979l34.158-19.666a2.971 2.971 0 001.489-2.575V44.666a3.075 3.075 0 00-.106-.774zM74.255 143.167l-29.648-16.779 31.136-17.926.001-.001 34.164-19.669 29.674 17.084-21.772 12.428-43.555 24.863zm68.329-76.259v33.841l-12.475-7.182-17.231-9.92V49.806l12.475 7.182 17.231 9.92zm2.97-39.335l29.693 17.095-29.693 17.095-29.693-17.095 29.693-17.095zM54.06 114.089l-12.475 7.182V46.733l17.231-9.92 12.475-7.182v74.537l-17.231 9.921zM38.614 7.398l29.693 17.095-29.693 17.095L8.921 24.493 38.614 7.398zM5.938 29.632l12.475 7.182 17.231 9.92v79.676l.001.005-.001.006c0 .114.032.221.045.333.017.146.021.294.059.434l.002.007c.032.117.094.222.14.334.051.124.088.255.156.371a.036.036 0 00.004.009c.061.105.149.191.222.288.081.105.149.22.244.314l.008.01c.084.083.19.142.284.215.106.083.202.178.32.247l.013.005.011.008 34.139 19.321v34.175L5.939 144.867V29.632h-.001zm136.646 115.235l-65.352 37.625V148.31l48.399-27.628 16.953-9.677v33.862zm35.646-61.22l-29.706 17.102V66.908l17.231-9.92 12.475-7.182v33.841z"/>
</g>
</svg>
</div>
<div class="mt-8 bg-white dark:bg-gray-800 overflow-hidden shadow sm:rounded-lg">
<div class="grid grid-cols-1 md:grid-cols-2">
<div class="p-6">
<div class="flex items-center">
<svg fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" viewBox="0 0 24 24" class="w-8 h-8 text-gray-500"><path d="M12 6.253v13m0-13C10.832 5.477 9.246 5 7.5 5S4.168 5.477 3 6.253v13C4.168 18.477 5.754 18 7.5 18s3.332.477 4.5 1.253m0-13C13.168 5.477 14.754 5 16.5 5c1.747 0 3.332.477 4.5 1.253v13C19.832 18.477 18.247 18 16.5 18c-1.746 0-3.332.477-4.5 1.253"></path></svg>
<div class="ml-4 text-lg leading-7 font-semibold"><a href="https://laravel.com/docs" class="underline text-gray-900 dark:text-white">Documentation</a></div>
</div>
<div class="ml-12">
<div class="mt-2 text-gray-600 dark:text-gray-400 text-sm">
Laravel has wonderful, thorough documentation covering every aspect of the framework. Whether you are new to the framework or have previous experience with Laravel, we recommend reading all of the documentation from beginning to end.
</div>
</div>
</div>
<div class="p-6 border-t border-gray-200 dark:border-gray-700 md:border-t-0 md:border-l">
<div class="flex items-center">
<svg fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" viewBox="0 0 24 24" class="w-8 h-8 text-gray-500"><path d="M3 9a2 2 0 012-2h.93a2 2 0 001.664-.89l.812-1.22A2 2 0 0110.07 4h3.86a2 2 0 011.664.89l.812 1.22A2 2 0 0018.07 7H19a2 2 0 012 2v9a2 2 0 01-2 2H5a2 2 0 01-2-2V9z"></path><path d="M15 13a3 3 0 11-6 0 3 3 0 016 0z"></path></svg>
<div class="ml-4 text-lg leading-7 font-semibold"><a href="https://laracasts.com" class="underline text-gray-900 dark:text-white">Laracasts</a></div>
</div>
<div class="ml-12">
<div class="mt-2 text-gray-600 dark:text-gray-400 text-sm">
Laracasts offers thousands of video tutorials on Laravel, PHP, and JavaScript development. Check them out, see for yourself, and massively level up your development skills in the process.
</div>
</div>
</div>
<div class="p-6 border-t border-gray-200 dark:border-gray-700">
<div class="flex items-center">
<svg fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" viewBox="0 0 24 24" class="w-8 h-8 text-gray-500"><path d="M7 8h10M7 12h4m1 8l-4-4H5a2 2 0 01-2-2V6a2 2 0 012-2h14a2 2 0 012 2v8a2 2 0 01-2 2h-3l-4 4z"></path></svg>
<div class="ml-4 text-lg leading-7 font-semibold"><a href="https://laravel-news.com/" class="underline text-gray-900 dark:text-white">Laravel News</a></div>
</div>
<div class="ml-12">
<div class="mt-2 text-gray-600 dark:text-gray-400 text-sm">
Laravel News is a community driven portal and newsletter aggregating all of the latest and most important news in the Laravel ecosystem, including new package releases and tutorials.
</div>
</div>
</div>
<div class="p-6 border-t border-gray-200 dark:border-gray-700 md:border-l">
<div class="flex items-center">
<svg fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" viewBox="0 0 24 24" class="w-8 h-8 text-gray-500"><path d="M3.055 11H5a2 2 0 012 2v1a2 2 0 002 2 2 2 0 012 2v2.945M8 3.935V5.5A2.5 2.5 0 0010.5 8h.5a2 2 0 012 2 2 2 0 104 0 2 2 0 012-2h1.064M15 20.488V18a2 2 0 012-2h3.064M21 12a9 9 0 11-18 0 9 9 0 0118 0z"></path></svg>
<div class="ml-4 text-lg leading-7 font-semibold text-gray-900 dark:text-white">Vibrant Ecosystem</div>
</div>
<div class="ml-12">
<div class="mt-2 text-gray-600 dark:text-gray-400 text-sm">
Laravel's robust library of first-party tools and libraries, such as <a href="https://forge.laravel.com" class="underline">Forge</a>, <a href="https://vapor.laravel.com" class="underline">Vapor</a>, <a href="https://nova.laravel.com" class="underline">Nova</a>, and <a href="https://envoyer.io" class="underline">Envoyer</a> help you take your projects to the next level. Pair them with powerful open source libraries like <a href="https://laravel.com/docs/billing" class="underline">Cashier</a>, <a href="https://laravel.com/docs/dusk" class="underline">Dusk</a>, <a href="https://laravel.com/docs/broadcasting" class="underline">Echo</a>, <a href="https://laravel.com/docs/horizon" class="underline">Horizon</a>, <a href="https://laravel.com/docs/sanctum" class="underline">Sanctum</a>, <a href="https://laravel.com/docs/telescope" class="underline">Telescope</a>, and more.
</div>
</div>
</div>
</div>
</div>
<div class="flex justify-center mt-4 sm:items-center sm:justify-between">
<div class="text-center text-sm text-gray-500 sm:text-left">
<div class="flex items-center">
<svg fill="none" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" viewBox="0 0 24 24" stroke="currentColor" class="-mt-px w-5 h-5 text-gray-400">
<path d="M3 3h2l.4 2M7 13h10l4-8H5.4M7 13L5.4 5M7 13l-2.293 2.293c-.63.63-.184 1.707.707 1.707H17m0 0a2 2 0 100 4 2 2 0 000-4zm-8 2a2 2 0 11-4 0 2 2 0 014 0z"></path>
</svg>
<a href="https://laravel.bigcartel.com" class="ml-1 underline">
Shop
</a>
<svg fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" viewBox="0 0 24 24" class="ml-4 -mt-px w-5 h-5 text-gray-400">
<path d="M4.318 6.318a4.5 4.5 0 000 6.364L12 20.364l7.682-7.682a4.5 4.5 0 00-6.364-6.364L12 7.636l-1.318-1.318a4.5 4.5 0 00-6.364 0z"></path>
</svg>
<a href="https://github.com/sponsors/taylorotwell" class="ml-1 underline">
Sponsor
</a>
</div>
</div>
<div class="ml-4 text-center text-sm text-gray-500 sm:text-right sm:ml-0">
Laravel v{{ Illuminate\Foundation\Application::VERSION }} (PHP v{{ PHP_VERSION }})
</div>
</div>
</div>
</div>
</body>
</html>
routes
+---- api.php
<?php
use App\Http\Controllers\Api\Articles\ArticleController;
use App\Http\Controllers\Api\Articles\CommentsController;
use App\Http\Controllers\Api\Articles\FavoritesController;
use App\Http\Controllers\Api\AuthController;
use App\Http\Controllers\Api\ProfileController;
use App\Http\Controllers\Api\TagsController;
use App\Http\Controllers\Api\UserController;
use Illuminate\Support\Facades\Route;
/*
|--------------------------------------------------------------------------
| API Routes
|--------------------------------------------------------------------------
|
| Here is where you can register API routes for your application. These
| routes are loaded by the RouteServiceProvider within a group which
| is assigned the "api" middleware group. Enjoy building your API!
|
*/
Route::name('api.')->group(function () {
Route::name('users.')->group(function () {
Route::middleware('auth:api')->group(function () {
Route::get('user', [UserController::class, 'show'])->name('current');
Route::put('user', [UserController::class, 'update'])->name('update');
});
Route::post('users/login', [AuthController::class, 'login'])->name('login');
Route::post('users', [AuthController::class, 'register'])->name('register');
});
Route::name('profiles.')->group(function () {
Route::middleware('auth:api')->group(function () {
Route::post('profiles/{username}/follow', [ProfileController::class, 'follow'])->name('follow');
Route::delete('profiles/{username}/follow', [ProfileController::class, 'unfollow'])->name('unfollow');
});
Route::get('profiles/{username}', [ProfileController::class, 'show'])->name('get');
});
Route::name('articles.')->group(function () {
Route::middleware('auth:api')->group(function () {
Route::get('articles/feed', [ArticleController::class, 'feed'])->name('feed');
Route::post('articles', [ArticleController::class, 'create'])->name('create');
Route::put('articles/{slug}', [ArticleController::class, 'update'])->name('update');
Route::delete('articles/{slug}', [ArticleController::class, 'delete'])->name('delete');
});
Route::get('articles', [ArticleController::class, 'list'])->name('list');
Route::get('articles/{slug}', [ArticleController::class, 'show'])->name('get');
Route::name('comments.')->group(function () {
Route::middleware('auth:api')->group(function () {
Route::post('articles/{slug}/comments', [CommentsController::class, 'create'])->name('create');
Route::delete('articles/{slug}/comments/{id}', [CommentsController::class, 'delete'])->name('delete');
});
Route::get('articles/{slug}/comments', [CommentsController::class, 'list'])->name('get');
});
Route::name('favorites.')->group(function () {
Route::middleware('auth:api')->group(function () {
Route::post('articles/{slug}/favorite', [FavoritesController::class, 'add'])->name('add');
Route::delete('articles/{slug}/favorite', [FavoritesController::class, 'remove'])->name('remove');
});
});
});
Route::name('tags.')->group(function () {
Route::get('tags', [TagsController::class, 'list'])->name('list');
});
});
+---- channels.php
<?php
use Illuminate\Support\Facades\Broadcast;
/*
|--------------------------------------------------------------------------
| Broadcast Channels
|--------------------------------------------------------------------------
|
| Here you may register all of the event broadcasting channels that your
| application supports. The given channel authorization callbacks are
| used to check if an authenticated user can listen to the channel.
|
*/
Broadcast::channel('App.Models.User.{id}', function ($user, $id) {
return (int) $user->id === (int) $id;
});
+---- console.php
<?php
use Illuminate\Foundation\Inspiring;
use Illuminate\Support\Facades\Artisan;
/*
|--------------------------------------------------------------------------
| Console Routes
|--------------------------------------------------------------------------
|
| This file is where you may define all of your Closure based console
| commands. Each Closure is bound to a command instance allowing a
| simple approach to interacting with each command's IO methods.
|
*/
Artisan::command('inspire', function () {
$this->comment(Inspiring::quote());
})->purpose('Display an inspiring quote');
+---- web.php
<?php
use Illuminate\Support\Facades\Route;
/*
|--------------------------------------------------------------------------
| Web Routes
|--------------------------------------------------------------------------
|
| Here is where you can register web routes for your application. These
| routes are loaded by the RouteServiceProvider within a group which
| contains the "web" middleware group. Now create something great!
|
*/
/*Route::get('/', function () {
return view('welcome');
});*/
storage
+---- api-docs
| +---- .gitignore
*
!.gitignore
+---- app
| +---- .gitignore
*
!public/
!.gitignore
| +---- public
| +---- .gitignore
*
!.gitignore
+---- framework
| +---- .gitignore
compiled.php
config.php
down
events.scanned.php
maintenance.php
routes.php
routes.scanned.php
schedule-*
services.json
| +---- cache
| +---- .gitignore
*
!data/
!.gitignore
| +---- data
| +---- .gitignore
*
!.gitignore
| +---- sessions
| +---- .gitignore
*
!.gitignore
| +---- testing
| +---- .gitignore
*
!.gitignore
| +---- views
| +---- .gitignore
*
!.gitignore
+---- logs
| +---- .gitignore
*
!.gitignore
tests
+---- CreatesApplication.php
<?php
namespace Tests;
use Illuminate\Contracts\Console\Kernel;
trait CreatesApplication
{
/**
* Creates the application.
*
* @return \Illuminate\Foundation\Application
*/
public function createApplication()
{
$app = require __DIR__.'/../bootstrap/app.php';
$app->make(Kernel::class)->bootstrap();
return $app;
}
}
+---- Feature
| +---- Api
| +---- Article
| +---- ArticleFeedTest.php
<?php
namespace Tests\Feature\Api\Article;
use App\Models\Article;
use App\Models\User;
use Illuminate\Support\Arr;
use Illuminate\Testing\Fluent\AssertableJson;
use Tests\TestCase;
class ArticleFeedTest extends TestCase
{
private User $user;
protected function setUp(): void
{
parent::setUp();
// create 30 articles
$authors = User::factory()
->has(Article::factory()->count(6), 'articles')
->count(5);
/** @var User $user */
$user = User::factory()
->has($authors, 'authors')
->create();
$this->user = $user;
}
public function testArticleFeed(): void
{
// new dummy articles shouldn't be returned
Article::factory()->count(5)->create();
$response = $this->actingAs($this->user)
->getJson('/api/articles/feed');
$response->assertOk()
->assertJson(fn (AssertableJson $json) =>
$json->where('articlesCount', 20)
->count('articles', 20)
->has('articles', fn (AssertableJson $items) =>
$items->each(fn (AssertableJson $item) =>
$item->where('tagList', [])
->whereAllType([
'slug' => 'string',
'title' => 'string',
'description' => 'string',
'body' => 'string',
'createdAt' => 'string',
'updatedAt' => 'string',
])
->whereAll([
'favorited' => false,
'favoritesCount' => 0,
])
->has('author', fn (AssertableJson $subItem) =>
$subItem->where('following', true)
->whereAllType([
'username' => 'string',
'bio' => 'string|null',
'image' => 'string|null',
])
)
)
)
);
// verify all authors are followed
foreach ($response['articles'] as $article) {
$this->assertTrue(
Arr::get($article, 'author.following'),
'Author of the article must be followed.'
);
}
}
public function testArticleFeedLimit(): void
{
$response = $this->actingAs($this->user)
->getJson('/api/articles/feed?limit=25');
$response->assertOk()
->assertJsonPath('articlesCount', 25)
->assertJsonCount(25, 'articles');
}
public function testArticleFeedOffset(): void
{
$response = $this->actingAs($this->user)
->getJson('/api/articles/feed?offset=20');
$response->assertOk()
->assertJsonPath('articlesCount', 10)
->assertJsonCount(10, 'articles');
}
/**
* @dataProvider queryProvider
* @param array<mixed> $data
* @param string|array<string> $errors
*/
public function testArticleFeedValidation(array $data, $errors): void
{
$response = $this->actingAs($this->user)
->json('GET', '/api/articles/feed', $data);
$response->assertUnprocessable()
->assertInvalid($errors);
}
public function testArticleFeedWithoutAuth(): void
{
$this->getJson('/api/articles/feed')
->assertUnauthorized();
}
/**
* @return array<int|string, array<mixed>>
*/
public function queryProvider(): array
{
$errors = ['limit', 'offset'];
return [
'not integer' => [['limit' => 'string', 'offset' => 0.123], $errors],
'less than zero' => [['limit' => -123, 'offset' => -321], $errors],
];
}
}
| +---- CreateArticleTest.php
<?php
namespace Tests\Feature\Api\Article;
use App\Models\Article;
use App\Models\Tag;
use App\Models\User;
use Illuminate\Foundation\Testing\WithFaker;
use Illuminate\Testing\Fluent\AssertableJson;
use Tests\TestCase;
class CreateArticleTest extends TestCase
{
use WithFaker;
public function testCreateArticle(): void
{
/** @var User $author */
$author = User::factory()->create();
$title = 'Original title';
$description = $this->faker->paragraph();
$body = $this->faker->text();
$tags = ['one', 'two', 'three', 'four', 'five'];
$response = $this->actingAs($author)
->postJson('/api/articles', [
'article' => [
'title' => $title,
'slug' => 'different-slug', // must be overwritten with title slug
'description' => $description,
'body' => $body,
'tagList' => $tags,
],
]);
$response->assertCreated()
->assertJson(fn (AssertableJson $json) =>
$json->has('article', fn (AssertableJson $item) =>
$item->where('tagList', $tags)
->whereAll([
'slug' => 'original-title',
'title' => $title,
'description' => $description,
'body' => $body,
'favorited' => false,
'favoritesCount' => 0,
])
->whereAllType([
'createdAt' => 'string',
'updatedAt' => 'string',
])
->has('author', fn (AssertableJson $subItem) =>
$subItem->whereAll([
'username' => $author->username,
'bio' => $author->bio,
'image' => $author->image,
'following' => false,
])
)
)
);
}
public function testCreateArticleEmptyTags(): void
{
/** @var User $author */
$author = User::factory()->create();
$response = $this->actingAs($author)
->postJson('/api/articles', [
'article' => [
'title' => $this->faker->sentence(4),
'description' => $this->faker->paragraph(),
'body' => $this->faker->text(),
'tagList' => [],
],
]);
$response->assertCreated()
->assertJsonPath('article.tagList', []);
}
public function testCreateArticleExistingTags(): void
{
/** @var User $author */
$author = User::factory()->create();
/** @var Tag[]|\Illuminate\Database\Eloquent\Collection $tags */
$tags = Tag::factory()
->count(5)
->create();
$tagsList = $tags->pluck('name')->toArray();
$response = $this->actingAs($author)
->postJson('/api/articles', [
'article' => [
'title' => $this->faker->sentence(4),
'description' => $this->faker->paragraph(),
'body' => $this->faker->text(),
'tagList' => $tagsList,
],
]);
$response->assertCreated()
->assertJsonPath('article.tagList', $tagsList);
$this->assertDatabaseCount('tags', 5);
$this->assertDatabaseCount('article_tag', 5);
}
/**
* @dataProvider articleProvider
* @param array<mixed> $data
* @param string|array<string> $errors
*/
public function testCreateArticleValidation(array $data, $errors): void
{
/** @var User $author */
$author = User::factory()->create();
$response = $this->actingAs($author)
->postJson('/api/articles', $data);
$response->assertUnprocessable()
->assertInvalid($errors);
}
public function testCreateArticleValidationUnique(): void
{
/** @var Article $article */
$article = Article::factory()->create();
$response = $this->actingAs($article->author)
->postJson('/api/articles', [
'article' => [
'title' => $article->title,
'description' => $this->faker->paragraph(),
'body' => $this->faker->text(),
],
]);
$response->assertUnprocessable()
->assertInvalid('slug');
}
public function testCreateArticleWithoutAuth(): void
{
$response = $this->postJson('/api/articles', [
'article' => [
'title' => $this->faker->sentence(4),
'description' => $this->faker->paragraph(),
'body' => $this->faker->text(),
],
]);
$response->assertUnauthorized();
}
/**
* @return array<int|string, array<mixed>>
*/
public function articleProvider(): array
{
$errors = ['title', 'description', 'body'];
$tags = ['tagList.0', 'tagList.1', 'tagList.2'];
return [
'required' => [[], $errors],
'not strings' => [[
'article' => [
'title' => 123,
'description' => [],
'body' => null,
'tagList' => [
123, [], null,
],
],
], array_merge($errors, $tags)],
'not array' => [['article' => ['tagList' => 'str']], 'tagList'],
];
}
}
| +---- DeleteArticleTest.php
<?php
namespace Tests\Feature\Api\Article;
use App\Models\Article;
use App\Models\User;
use Tests\TestCase;
class DeleteArticleTest extends TestCase
{
private Article $article;
private User $user;
protected function setUp(): void
{
parent::setUp();
/** @var Article $article */
$article = Article::factory()->create();
/** @var User $user */
$user = User::factory()->create();
$this->article = $article;
$this->user = $user;
}
public function testDeleteArticle(): void
{
$this->actingAs($this->article->author)
->deleteJson("/api/articles/{$this->article->slug}")
->assertOk();
$this->assertModelMissing($this->article);
}
public function testDeleteForeignArticle(): void
{
$this->actingAs($this->user)
->deleteJson("/api/articles/{$this->article->slug}")
->assertForbidden();
$this->assertModelExists($this->article);
}
public function testDeleteNonExistentArticle(): void
{
$this->actingAs($this->user)
->deleteJson("/api/articles/non-existent")
->assertNotFound();
}
public function testDeleteArticleWithoutAuth(): void
{
$this->deleteJson("/api/articles/{$this->article->slug}")
->assertUnauthorized();
$this->assertModelExists($this->article);
}
}
| +---- ListArticlesTest.php
<?php
namespace Tests\Feature\Api\Article;
use App\Models\Article;
use App\Models\Tag;
use App\Models\User;
use Illuminate\Support\Arr;
use Illuminate\Testing\Fluent\AssertableJson;
use Tests\TestCase;
class ListArticlesTest extends TestCase
{
protected function setUp(): void
{
parent::setUp();
Article::factory()->count(30)->create();
}
public function testListArticles(): void
{
$response = $this->getJson('/api/articles');
$response->assertOk()
->assertJson(fn (AssertableJson $json) =>
$json->where('articlesCount', 20)
->count('articles', 20)
->has('articles', fn (AssertableJson $items) =>
$items->each(fn (AssertableJson $item) =>
$item->missing('favorited')
->whereAllType([
'slug' => 'string',
'title' => 'string',
'description' => 'string',
'body' => 'string',
'createdAt' => 'string',
'updatedAt' => 'string',
])
->whereAll([
'tagList' => [],
'favoritesCount' => 0,
])
->has('author', fn (AssertableJson $subItem) =>
$subItem->missing('following')
->whereAllType([
'username' => 'string',
'bio' => 'string|null',
'image' => 'string|null',
])
)
)
)
);
}
public function testListArticlesByTag(): void
{
// dummy articles shouldn't be returned
Article::factory()
->has(Tag::factory()->count(3))
->count(20)
->create();
/** @var Tag $tag */
$tag = Tag::factory()
->has(Article::factory()->count(10), 'articles')
->create();
$response = $this->getJson("/api/articles?tag={$tag->name}");
$response->assertOk()
->assertJsonPath('articlesCount', 10)
->assertJsonCount(10, 'articles');
// verify has tag
foreach ($response['articles'] as $article) {
$this->assertContains(
$tag->name, Arr::get($article, 'tagList'),
"Article must have tag {$tag->name}"
);
}
}
public function testListArticlesByAuthor(): void
{
/** @var User $author */
$author = User::factory()
->has(Article::factory()->count(5), 'articles')
->create();
$response = $this->getJson("/api/articles?author={$author->username}");
$response->assertOk()
->assertJsonPath('articlesCount', 5)
->assertJsonCount(5, 'articles');
// verify same author
foreach ($response['articles'] as $article) {
$this->assertSame(
$author->username,
Arr::get($article, 'author.username'),
"Author must be {$author->username}."
);
}
}
public function testListArticlesByFavored(): void
{
/** @var User $user */
$user = User::factory()
->has(Article::factory()->count(15), 'favorites')
->create();
$response = $this->getJson("/api/articles?favorited={$user->username}");
$response->assertOk()
->assertJsonPath('articlesCount', 15)
->assertJsonCount(15, 'articles');
// verify favored
foreach ($response['articles'] as $article) {
$this->assertSame(
1, Arr::get($article, 'favoritesCount'),
"Article must be favored by {$user->username}."
);
}
}
public function testArticleFeedLimit(): void
{
$response = $this->getJson('/api/articles?limit=25');
$response->assertOk()
->assertJsonPath('articlesCount', 25)
->assertJsonCount(25, 'articles');
}
public function testArticleFeedOffset(): void
{
$response = $this->getJson('/api/articles?offset=20');
$response->assertOk()
->assertJsonPath('articlesCount', 10)
->assertJsonCount(10, 'articles');
}
/**
* @dataProvider queryProvider
* @param array<mixed> $data
* @param string|array<string> $errors
*/
public function testArticleListValidation(array $data, $errors): void
{
$response = $this->json('GET', '/api/articles', $data);
$response->assertUnprocessable()
->assertInvalid($errors);
}
/**
* @return array<int|string, array<mixed>>
*/
public function queryProvider(): array
{
$errors = ['limit', 'offset'];
return [
'not integer' => [['limit' => 'string', 'offset' => 0.123], $errors],
'less than zero' => [['limit' => -123, 'offset' => -321], $errors],
'not strings' => [[
'tag' => 123,
'author' => [],
'favorited' => null,
], ['tag', 'author', 'favorited']],
];
}
}
| +---- ShowArticleTest.php
<?php
namespace Tests\Feature\Api\Article;
use App\Models\Article;
use App\Models\Tag;
use App\Models\User;
use Illuminate\Testing\Fluent\AssertableJson;
use Tests\TestCase;
class ShowArticleTest extends TestCase
{
public function testShowArticleWithoutAuth(): void
{
/** @var Article $article */
$article = Article::factory()
->has(Tag::factory()->count(5), 'tags')
->create();
$author = $article->author;
$tags = $article->tags;
$response = $this->getJson("/api/articles/{$article->slug}");
$response->assertOk()
->assertJson(fn (AssertableJson $json) =>
$json->has('article', fn (AssertableJson $item) =>
$item->missing('favorited')
->whereAll([
'slug' => $article->slug,
'title' => $article->title,
'description' => $article->description,
'body' => $article->body,
'tagList' => $tags->pluck('name'),
'createdAt' => $article->created_at?->toISOString(),
'updatedAt' => $article->updated_at?->toISOString(),
'favoritesCount' => 0,
])
->has('author', fn (AssertableJson $subItem) =>
$subItem->missing('following')
->whereAll([
'username' => $author->username,
'bio' => $author->bio,
'image' => $author->image,
])
)
)
);
}
public function testShowFavoredArticleWithUnfollowedAuthor(): void
{
/** @var User $user */
$user = User::factory()->create();
/** @var Article $article */
$article = Article::factory()
->hasAttached($user, [], 'favoredUsers')
->create();
$this->assertTrue($article->favoredUsers->contains($user));
$response = $this->actingAs($user)
->getJson("/api/articles/{$article->slug}");
$response->assertOk()
->assertJsonPath('article.favorited', true)
->assertJsonPath('article.favoritesCount', 1)
->assertJsonPath('article.author.following', false);
}
public function testShowUnfavoredArticleWithFollowedAuthor(): void
{
/** @var User $user */
$user = User::factory()->create();
/** @var User $author */
$author = User::factory()
->hasAttached($user, [], 'followers')
->create();
/** @var Article $article */
$article = Article::factory()
->for($author, 'author')
->create();
$this->assertTrue($author->followers->contains($user));
$response = $this->actingAs($user)
->getJson("/api/articles/{$article->slug}");
$response->assertOk()
->assertJsonPath('article.favorited', false)
->assertJsonPath('article.favoritesCount', 0)
->assertJsonPath('article.author.following', true);
}
public function testShowNonExistentArticle(): void
{
$this->getJson('/api/articles/non-existent')
->assertNotFound();
}
}
| +---- UpdateArticleTest.php
<?php
namespace Tests\Feature\Api\Article;
use App\Models\Article;
use App\Models\User;
use Illuminate\Foundation\Testing\WithFaker;
use Illuminate\Testing\Fluent\AssertableJson;
use Tests\TestCase;
class UpdateArticleTest extends TestCase
{
use WithFaker;
private Article $article;
protected function setUp(): void
{
parent::setUp();
/** @var Article $article */
$article = Article::factory()->create();
$this->article = $article;
}
public function testUpdateArticle(): void
{
$author = $this->article->author;
$this->assertNotEquals($title = 'Updated title', $this->article->title);
$this->assertNotEquals($fakeSlug = 'overwrite-slug', $this->article->slug);
$this->assertNotEquals($description = 'New description.', $this->article->description);
$this->assertNotEquals($body = 'Updated article body.', $this->article->body);
// update by one to check required_without_all rule
$this->actingAs($author)
->putJson("/api/articles/{$this->article->slug}", ['article' => ['description' => $description]])
->assertOk();
$this->actingAs($author)
->putJson("/api/articles/{$this->article->slug}", ['article' => ['body' => $body]]);
$response = $this->actingAs($author)
->putJson("/api/articles/{$this->article->slug}", [
'article' => [
'title' => $title,
'slug' => $fakeSlug, // must be overwritten with title slug
],
]);
$response->assertOk()
->assertJson(fn (AssertableJson $json) =>
$json->has('article', fn (AssertableJson $item) =>
$item->whereType('updatedAt', 'string')
->whereAll([
'slug' => 'updated-title',
'title' => $title,
'description' => $description,
'body' => $body,
'tagList' => [],
'createdAt' => $this->article->created_at?->toISOString(),
'favorited' => false,
'favoritesCount' => 0,
])
->has('author', fn (AssertableJson $subItem) =>
$subItem->whereAll([
'username' => $author->username,
'bio' => $author->bio,
'image' => $author->image,
'following' => false,
])
)
)
);
}
public function testUpdateForeignArticle(): void
{
/** @var User $user */
$user = User::factory()->create();
$response = $this->actingAs($user)
->putJson("/api/articles/{$this->article->slug}", [
'article' => [
'body' => $this->faker->text(),
],
]);
$response->assertForbidden();
}
/**
* @dataProvider articleProvider
* @param array<mixed> $data
* @param string|array<string> $errors
*/
public function testUpdateArticleValidation(array $data, $errors): void
{
$response = $this->actingAs($this->article->author)
->putJson("/api/articles/{$this->article->slug}", $data);
$response->assertUnprocessable()
->assertInvalid($errors);
}
public function testUpdateArticleValidationUnique(): void
{
/** @var Article $anotherArticle */
$anotherArticle = Article::factory()->create();
$response = $this->actingAs($this->article->author)
->putJson("/api/articles/{$this->article->slug}", [
'article' => [
'title' => $anotherArticle->title,
],
]);
$response->assertUnprocessable()
->assertInvalid('slug');
}
public function testSelfUpdateArticleValidationUnique(): void
{
$response = $this->actingAs($this->article->author)
->putJson("/api/articles/{$this->article->slug}", [
'article' => [
'title' => $this->article->title,
],
]);
$response->assertOk()
->assertJsonPath('article.slug', $this->article->slug);
}
public function testUpdateNonExistentArticle(): void
{
/** @var User $user */
$user = User::factory()->create();
$response = $this->actingAs($user)
->putJson('/api/articles/non-existent', [
'article' => [
'body' => $this->faker->text(),
],
]);
$response->assertNotFound();
}
public function testUpdateArticleWithoutAuth(): void
{
$response = $this->putJson("/api/articles/{$this->article->slug}", [
'article' => [
'body' => $this->faker->text(),
],
]);
$response->assertUnauthorized();
}
/**
* @return array<int|string, array<mixed>>
*/
public function articleProvider(): array
{
$errors = ['title', 'description', 'body'];
return [
'required' => [[], $errors],
'not strings' => [[
'article' => [
'title' => 123,
'description' => [],
'body' => null,
],
], $errors],
'empty strings' => [[
'article' => [
'title' => '',
'description' => '',
'body' => '',
],
], $errors],
];
}
}
| +---- Auth
| +---- JwtGuardTest.php
<?php
namespace Tests\Feature\Api\Auth;
use App\Jwt;
use App\Models\User;
use Tests\TestCase;
class JwtGuardTest extends TestCase
{
private User $user;
private string $token;
protected function setUp(): void
{
parent::setUp();
/** @var User $user */
$user = User::factory()->create();
$this->user = $user;
$this->token = Jwt\Generator::token($user);
}
public function testGuardTokenParse(): void
{
$this->getJson('/api/user?token=string')
->assertUnauthorized();
}
public function testGuardTokenValidation(): void
{
$this->user->delete();
$this->getJson("/api/user?token={$this->token}")
->assertUnauthorized();
}
public function testGuardWithHeaderToken(): void
{
$response = $this->getJson('/api/user', [
'Authorization' => "Token {$this->token}",
]);
$response->assertOk();
}
public function testGuardWithQueryToken(): void
{
$this->getJson("/api/user?token={$this->token}")
->assertOk();
}
public function testGuardWithJsonBodyToken(): void
{
$response = $this->json('GET', '/api/user', [
'token' => $this->token,
]);
$response->assertOk();
}
}
| +---- LoginTest.php
<?php
namespace Tests\Feature\Api\Auth;
use App\Jwt;
use App\Models\User;
use Illuminate\Foundation\Testing\WithFaker;
use Illuminate\Support\Facades\Hash;
use Illuminate\Testing\Fluent\AssertableJson;
use Tests\TestCase;
class LoginTest extends TestCase
{
use WithFaker;
public function testLoginUser(): void
{
$password = $this->faker->password(8);
/** @var User $user */
$user = User::factory()
->state(['password' => Hash::make($password)])
->create();
$response = $this->postJson('/api/users/login', [
'user' => [
'email' => $user->email,
'password' => $password,
],
]);
$response->assertOk()
->assertJson(fn (AssertableJson $json) =>
$json->has('user', fn (AssertableJson $item) =>
$item->whereType('token', 'string')
->whereAll([
'username' => $user->username,
'email' => $user->email,
'bio' => $user->bio,
'image' => $user->image,
])
)
);
$token = Jwt\Parser::parse($response['user']['token']);
$this->assertTrue(Jwt\Validator::validate($token));
}
public function testLoginUserFail(): void
{
$password = 'knownPassword';
/** @var User $user */
$user = User::factory()
->state(['password' => Hash::make($password)])
->create();
$response = $this->postJson('/api/users/login', [
'user' => [
'email' => $user->email,
'password' => 'differentPassword',
],
]);
$response->assertUnprocessable()
->assertInvalid('user');
}
/**
* @dataProvider credentialsProvider
* @param array<mixed> $data
* @param string|array<string> $errors
*/
public function testLoginUserValidation(array $data, $errors): void
{
$response = $this->postJson('/api/users/login', $data);
$response->assertUnprocessable()
->assertInvalid($errors);
}
/**
* @return array<int|string, array<mixed>>
*/
public function credentialsProvider(): array
{
$errors = ['email', 'password'];
return [
'required' => [[], $errors],
'not strings' => [[
'user' => [
'email' => [],
'password' => null,
],
], $errors],
'empty strings' => [[
'user' => [
'email' => '',
'password' => '',
],
], $errors],
'not email' => [['user' => ['email' => 'not an email']], 'email'],
];
}
}
| +---- RegisterTest.php
<?php
namespace Tests\Feature\Api\Auth;
use App\Jwt;
use App\Models\User;
use Illuminate\Foundation\Testing\WithFaker;
use Illuminate\Testing\Fluent\AssertableJson;
use Tests\TestCase;
class RegisterTest extends TestCase
{
use WithFaker;
public function testRegisterUser(): void
{
$username = $this->faker->userName();
$email = $this->faker->safeEmail();
$response = $this->postJson('/api/users', [
'user' => [
'username' => $username,
'email' => $email,
'password' => $this->faker->password(8),
],
]);
$response->assertCreated()
->assertJson(fn (AssertableJson $json) =>
$json->has('user', fn (AssertableJson $item) =>
$item->whereType('token', 'string')
->whereAll([
'username' => $username,
'email' => $email,
'bio' => null,
'image' => null,
])
)
);
$token = Jwt\Parser::parse($response['user']['token']);
$this->assertTrue(Jwt\Validator::validate($token));
}
/**
* @dataProvider userProvider
* @param array<mixed> $data
* @param string|array<string> $errors
*/
public function testRegisterUserValidation(array $data, $errors): void
{
$response = $this->postJson('/api/users', $data);
$response->assertUnprocessable()
->assertInvalid($errors);
}
public function testRegisterUserValidationUnique(): void
{
/** @var User $user */
$user = User::factory()->create();
$response = $this->postJson('/api/users', [
'user' => [
'username' => $user->username,
'email' => $user->email,
'password' => $this->faker->password(8),
],
]);
$response->assertUnprocessable()
->assertInvalid(['username', 'email']);
}
/**
* @return array<int|string, array<mixed>>
*/
public function userProvider(): array
{
$errors = ['username', 'email', 'password'];
return [
'required' => [[], $errors],
'not strings' => [[
'user' => [
'username' => 123,
'email' => [],
'password' => null,
],
], $errors],
'empty strings' => [[
'user' => [
'username' => '',
'email' => '',
'password' => '',
],
], $errors],
'bad username' => [['user' => ['username' => 'user n@me']], 'username'],
'not email' => [['user' => ['email' => 'not an email']], 'email'],
'small password' => [['user' => ['password' => 'small']], 'password'],
];
}
}
| +---- Comments
| +---- CreateCommentTest.php
<?php
namespace Tests\Feature\Api\Comments;
use App\Models\Article;
use App\Models\User;
use Illuminate\Foundation\Testing\WithFaker;
use Illuminate\Testing\Fluent\AssertableJson;
use Tests\TestCase;
class CreateCommentTest extends TestCase
{
use WithFaker;
private Article $article;
private User $user;
protected function setUp(): void
{
parent::setUp();
/** @var Article $article */
$article = Article::factory()->create();
/** @var User $user */
$user = User::factory()->create();
$this->article = $article;
$this->user = $user;
}
public function testCreateCommentForArticle(): void
{
$message = $this->faker->sentence();
$response = $this->actingAs($this->user)
->postJson("/api/articles/{$this->article->slug}/comments", [
'comment' => [
'body' => $message,
],
]);
$response->assertCreated()
->assertJson(fn (AssertableJson $json) =>
$json->has('comment', fn (AssertableJson $comment) =>
$comment->where('body', $message)
->whereAllType([
'id' => 'integer',
'createdAt' => 'string',
'updatedAt' => 'string',
])
->has('author', fn (AssertableJson $author) =>
$author->whereAll([
'username' => $this->user->username,
'bio' => $this->user->bio,
'image' => $this->user->image,
'following' => false,
])
)
)
);
}
/**
* @dataProvider commentProvider
* @param array<mixed> $data
*/
public function testCreateCommentValidation(array $data): void
{
$response = $this->actingAs($this->user)
->postJson("/api/articles/{$this->article->slug}/comments", $data);
$response->assertUnprocessable()
->assertInvalid('body');
}
public function testCreateCommentForNonExistentArticle(): void
{
$response = $this->actingAs($this->user)
->postJson("/api/articles/non-existent/comments", [
'comment' => [
'body' => $this->faker->sentence(),
],
]);
$response->assertNotFound();
}
public function testCreateCommentWithoutAuth(): void
{
$response = $this->postJson("/api/articles/{$this->article->slug}/comments", [
'comment' => [
'body' => $this->faker->sentence(),
],
]);
$response->assertUnauthorized();
}
/**
* @return array<int|string, array<mixed>>
*/
public function commentProvider(): array
{
return [
'empty data' => [[]],
'no comment wrap' => [['body' => 'example-message']],
'empty message' => [['comment' => ['body' => '']]],
'integer message' => [['comment' => ['body' => 123]]],
'array message' => [['comment' => ['body' => []]]],
];
}
}
| +---- DeleteCommentTest.php
<?php
namespace Tests\Feature\Api\Comments;
use App\Models\Article;
use App\Models\Comment;
use App\Models\User;
use Tests\TestCase;
class DeleteCommentTest extends TestCase
{
private Comment $comment;
private Article $article;
protected function setUp(): void
{
parent::setUp();
/** @var Comment $comment */
$comment = Comment::factory()->create();
$this->comment = $comment;
$this->article = $comment->article;
}
public function testDeleteArticleComment(): void
{
$this->actingAs($this->comment->author)
->deleteJson("/api/articles/{$this->article->slug}/comments/{$this->comment->getKey()}")
->assertOk();
$this->assertModelMissing($this->comment);
}
public function testDeleteCommentOfNonExistentArticle(): void
{
$this->assertNotSame($nonExistentSlug = 'non-existent', $this->article->slug);
$this->actingAs($this->comment->author)
->deleteJson("/api/articles/{$nonExistentSlug}/comments/{$this->comment->getKey()}")
->assertNotFound();
$this->assertModelExists($this->comment);
}
/**
* @dataProvider nonExistentIdProvider
* @param mixed $nonExistentId
*/
public function testDeleteNonExistentArticleComment($nonExistentId): void
{
$this->assertNotEquals($nonExistentId, $this->comment->getKey());
$this->actingAs($this->comment->author)
->deleteJson("/api/articles/{$this->article->slug}/comments/{$nonExistentId}")
->assertNotFound();
$this->assertModelExists($this->comment);
}
public function testDeleteForeignArticleComment(): void
{
/** @var User $user */
$user = User::factory()->create();
$this->actingAs($user)
->deleteJson("/api/articles/{$this->article->slug}/comments/{$this->comment->getKey()}")
->assertForbidden();
$this->assertModelExists($this->comment);
}
public function testDeleteCommentOfForeignArticle(): void
{
/** @var Article $article */
$article = Article::factory()->create();
$this->actingAs($this->comment->author)
->deleteJson("/api/articles/{$article->slug}/comments/{$this->comment->getKey()}")
->assertNotFound();
$this->assertModelExists($this->comment);
}
public function testDeleteCommentWithoutAuth(): void
{
$this->deleteJson("/api/articles/{$this->article->slug}/comments/{$this->comment->getKey()}")
->assertUnauthorized();
$this->assertModelExists($this->comment);
}
/**
* @return array<int|string, array<mixed>>
*/
public function nonExistentIdProvider(): array
{
return [
'int key' => [123],
'string key' => ['non-existent'],
];
}
}
| +---- ListCommentsTest.php
<?php
namespace Tests\Feature\Api\Comments;
use App\Models\Article;
use App\Models\Comment;
use App\Models\User;
use Illuminate\Testing\Fluent\AssertableJson;
use Tests\TestCase;
class ListCommentsTest extends TestCase
{
public function testListArticleCommentsWithoutAuth(): void
{
/** @var Article $article */
$article = Article::factory()
->has(Comment::factory()->count(5), 'comments')
->create();
/** @var Comment $comment */
$comment = $article->comments->first();
$author = $comment->author;
$response = $this->getJson("/api/articles/{$article->slug}/comments");
$response->assertOk()
->assertJson(fn (AssertableJson $json) =>
$json->has('comments', 5, fn (AssertableJson $item) =>
$item->where('id', $comment->getKey())
->whereAll([
'createdAt' => $comment->created_at?->toISOString(),
'updatedAt' => $comment->updated_at?->toISOString(),
'body' => $comment->body,
])
->has('author', fn (AssertableJson $subItem) =>
$subItem->missing('following')
->whereAll([
'username' => $author->username,
'bio' => $author->bio,
'image' => $author->image,
])
)
)
);
}
public function testListArticleCommentsFollowedAuthor(): void
{
/** @var Comment $comment */
$comment = Comment::factory()->create();
$author = $comment->author;
/** @var User $follower */
$follower = User::factory()
->hasAttached($author, [], 'authors')
->create();
$article = $comment->article;
$response = $this->actingAs($follower)
->getJson("/api/articles/{$article->slug}/comments");
$response->assertOk()
->assertJsonPath('comments.0.author.following', true);
}
public function testListArticleCommentsUnfollowedAuthor(): void
{
/** @var User $user */
$user = User::factory()->create();
/** @var Article $article */
$article = Article::factory()
->has(Comment::factory(), 'comments')
->create();
$response = $this->actingAs($user)
->getJson("/api/articles/{$article->slug}/comments");
$response->assertOk()
->assertJsonPath('comments.0.author.following', false);
}
public function testListEmptyArticleComments(): void
{
/** @var Article $article */
$article = Article::factory()->create();
$response = $this->getJson("/api/articles/{$article->slug}/comments");
$response->assertOk()
->assertExactJson(['comments' => []]);
}
public function testListCommentsOfNonExistentArticle(): void
{
$this->getJson('/api/articles/non-existent/comments')
->assertNotFound();
}
}
| +---- Favorites
| +---- AddFavoritesTest.php
<?php
namespace Tests\Feature\Api\Favorites;
use App\Models\Article;
use App\Models\User;
use Tests\TestCase;
class AddFavoritesTest extends TestCase
{
private User $user;
protected function setUp(): void
{
parent::setUp();
/** @var User $user */
$user = User::factory()->create();
$this->user = $user;
}
public function testAddArticleToFavorites(): void
{
/** @var Article $article */
$article = Article::factory()->create();
$response = $this->actingAs($this->user)
->postJson("/api/articles/{$article->slug}/favorite");
$response->assertOk()
->assertJsonPath('article.favorited', true)
->assertJsonPath('article.favoritesCount', 1);
$this->assertTrue($this->user->favorites->contains($article));
$repeatedResponse = $this->actingAs($this->user)
->postJson("/api/articles/{$article->slug}/favorite");
$repeatedResponse->assertOk()
->assertJsonPath('article.favoritesCount', 1);
$this->assertDatabaseCount('article_favorite', 1);
}
public function testAddNonExistentArticleToFavorites(): void
{
$this->actingAs($this->user)
->postJson('/api/articles/non-existent/favorite')
->assertNotFound();
}
public function testAddArticleToFavoritesWithoutAuth(): void
{
/** @var Article $article */
$article = Article::factory()->create();
$this->postJson("/api/articles/{$article->slug}/favorite")
->assertUnauthorized();
}
}
| +---- RemoveFavoritesTest.php
<?php
namespace Tests\Feature\Api\Favorites;
use App\Models\Article;
use App\Models\User;
use Tests\TestCase;
class RemoveFavoritesTest extends TestCase
{
private User $user;
protected function setUp(): void
{
parent::setUp();
/** @var User $user */
$user = User::factory()->create();
$this->user = $user;
}
public function testRemoveArticleFromFavorites(): void
{
/** @var Article $article */
$article = Article::factory()
->hasAttached($this->user, [], 'favoredUsers')
->create();
$response = $this->actingAs($this->user)
->deleteJson("/api/articles/{$article->slug}/favorite");
$response->assertOk()
->assertJsonPath('article.favorited', false)
->assertJsonPath('article.favoritesCount', 0);
$this->assertTrue($this->user->favorites->doesntContain($article));
$this->actingAs($this->user)
->deleteJson("/api/articles/{$article->slug}/favorite")
->assertOk();
}
public function testRemoveNonExistentArticleFromFavorites(): void
{
$this->actingAs($this->user)
->deleteJson('/api/articles/non-existent/favorite')
->assertNotFound();
}
public function testRemoveArticleFromFavoritesWithoutAuth(): void
{
/** @var Article $article */
$article = Article::factory()->create();
$this->deleteJson("/api/articles/{$article->slug}/favorite")
->assertUnauthorized();
}
}
| +---- Profile
| +---- FollowProfileTest.php
<?php
namespace Tests\Feature\Api\Profile;
use App\Models\User;
use Tests\TestCase;
class FollowProfileTest extends TestCase
{
private User $user;
protected function setUp(): void
{
parent::setUp();
/** @var User $user */
$user = User::factory()->create();
$this->user = $user;
}
public function testFollowProfile(): void
{
/** @var User $follower */
$follower = User::factory()->create();
$response = $this->actingAs($follower)
->postJson("/api/profiles/{$this->user->username}/follow");
$response->assertOk()
->assertJsonPath('profile.following', true);
$this->assertTrue($this->user->followers->contains($follower));
$this->actingAs($follower)
->postJson("/api/profiles/{$this->user->username}/follow")
->assertOk();
$this->assertDatabaseCount('author_follower', 1);
}
public function testFollowProfileWithoutAuth(): void
{
$this->postJson("/api/profiles/{$this->user->username}/follow")
->assertUnauthorized();
}
public function testFollowNonExistentProfile(): void
{
$this->actingAs($this->user)
->postJson('/api/profiles/non-existent/follow')
->assertNotFound();
}
}
| +---- ShowProfileTest.php
<?php
namespace Tests\Feature\Api\Profile;
use App\Models\User;
use Tests\TestCase;
class ShowProfileTest extends TestCase
{
private User $profile;
protected function setUp(): void
{
parent::setUp();
/** @var User $user */
$user = User::factory()->create();
$this->profile = $user;
}
public function testShowProfileWithoutAuth(): void
{
/** @var User $profile */
$profile = User::factory()->create();
$response = $this->getJson("/api/profiles/{$profile->username}");
$response->assertOk()
->assertExactJson([
'profile' => [
'username' => $profile->username,
'bio' => $profile->bio,
'image' => $profile->image,
],
]);
}
public function testShowUnfollowedProfile(): void
{
/** @var User $user */
$user = User::factory()->create();
$response = $this->actingAs($user)
->getJson("/api/profiles/{$this->profile->username}");
$response->assertOk()
->assertJsonPath('profile.following', false);
}
public function testShowFollowedProfile(): void
{
/** @var User $user */
$user = User::factory()
->hasAttached($this->profile, [], 'authors')
->create();
$response = $this->actingAs($user)
->getJson("/api/profiles/{$this->profile->username}");
$response->assertOk()
->assertJsonPath('profile.following', true);
}
public function testShowNonExistentProfile(): void
{
$this->getJson('/api/profiles/non-existent')
->assertNotFound();
}
}
| +---- UnfollowProfileTest.php
<?php
namespace Tests\Feature\Api\Profile;
use App\Models\User;
use Tests\TestCase;
class UnfollowProfileTest extends TestCase
{
private User $user;
protected function setUp(): void
{
parent::setUp();
/** @var User $user */
$user = User::factory()->create();
$this->user = $user;
}
public function testUnfollowProfile(): void
{
/** @var User $follower */
$follower = User::factory()
->hasAttached($this->user, [], 'authors')
->create();
$response = $this->actingAs($follower)
->deleteJson("/api/profiles/{$this->user->username}/follow");
$response->assertOk()
->assertJsonPath('profile.following', false);
$this->assertTrue($this->user->followers->doesntContain($follower));
$this->actingAs($follower)
->deleteJson("/api/profiles/{$this->user->username}/follow")
->assertOk();
}
public function testUnfollowProfileWithoutAuth(): void
{
$this->deleteJson("/api/profiles/{$this->user->username}/follow")
->assertUnauthorized();
}
public function testUnfollowNonExistentProfile(): void
{
$this->actingAs($this->user)
->deleteJson('/api/profiles/non-existent/follow')
->assertNotFound();
}
}
| +---- TagsTest.php
<?php
namespace Tests\Feature\Api;
use App\Http\Resources\Api\TagResource;
use App\Models\Tag;
use Illuminate\Http\Request;
use Tests\TestCase;
class TagsTest extends TestCase
{
public function testReturnsTagsList(): void
{
$tags = Tag::factory()->count(5)->create();
$response = $this->getJson('/api/tags');
$response->assertOk()
->assertExactJson([
'tags' => $tags->pluck('name'),
]);
}
public function testReturnsEmptyTagsList(): void
{
$response = $this->getJson('/api/tags');
$response->assertOk()
->assertExactJson(['tags' => []]);
}
public function testTagResource(): void
{
/** @var Tag $tag */
$tag = Tag::factory()->create();
$resource = new TagResource($tag);
/** @var Request $request */
$request = $this->mock(Request::class);
$tagResource = $resource->toArray($request);
$this->assertSame(['name' => $tag->name], $tagResource);
}
}
| +---- User
| +---- ShowUserTest.php
<?php
namespace Tests\Feature\Api\User;
use App\Jwt;
use App\Models\User;
use Illuminate\Testing\Fluent\AssertableJson;
use Tests\TestCase;
class ShowUserTest extends TestCase
{
public function testShowUser(): void
{
/** @var User $user */
$user = User::factory()->create();
$response = $this->actingAs($user)
->getJson('/api/user');
$response->assertOk()
->assertJson(fn (AssertableJson $json) =>
$json->has('user', fn (AssertableJson $item) =>
$item->whereType('token', 'string')
->whereAll([
'username' => $user->username,
'email' => $user->email,
'bio' => $user->bio,
'image' => $user->image,
])
)
);
$token = Jwt\Parser::parse($response['user']['token']);
$this->assertTrue(Jwt\Validator::validate($token));
}
public function testShowUserWithoutAuth(): void
{
$this->getJson('/api/user')
->assertUnauthorized();
}
}
| +---- UpdateUserTest.php
<?php
namespace Tests\Feature\Api\User;
use App\Models\User;
use Illuminate\Testing\Fluent\AssertableJson;
use Tests\TestCase;
class UpdateUserTest extends TestCase
{
private User $user;
protected function setUp(): void
{
parent::setUp();
/** @var User $user */
$user = User::factory()->create();
$this->user = $user;
}
public function testUpdateUser(): void
{
$this->assertNotEquals($username = 'new.username', $this->user->username);
$this->assertNotEquals($email = 'newEmail@example.com', $this->user->email);
$this->assertNotEquals($bio = 'New bio information.', $this->user->bio);
$this->assertNotEquals($image = 'https://example.com/image.png', $this->user->image);
// update by one to check required_without_all rule
$this->actingAs($this->user)
->putJson('/api/user', ['user' => ['username' => $username]])
->assertOk();
$this->actingAs($this->user)
->putJson('/api/user', ['user' => ['email' => $email]])
->assertOk();
$this->actingAs($this->user)
->putJson('/api/user', ['user' => ['bio' => $bio]]);
$response = $this->actingAs($this->user)
->putJson('/api/user', ['user' => ['image' => $image]]);
$response->assertOk()
->assertJson(fn (AssertableJson $json) =>
$json->has('user', fn (AssertableJson $item) =>
$item->whereType('token', 'string')
->whereAll([
'username' => $username,
'email' => $email,
'bio' => $bio,
'image' => $image,
])
)
);
}
/**
* @dataProvider userProvider
* @param array<mixed> $data
* @param string|array<string> $errors
*/
public function testUpdateUserValidation(array $data, $errors): void
{
$response = $this->actingAs($this->user)
->putJson('/api/user', $data);
$response->assertUnprocessable()
->assertInvalid($errors);
}
public function testUpdateUserValidationUnique(): void
{
/** @var User $anotherUser */
$anotherUser = User::factory()->create();
$response = $this->actingAs($this->user)
->putJson('/api/user', [
'user' => [
'username' => $anotherUser->username,
'email' => $anotherUser->email,
],
]);
$response->assertUnprocessable()
->assertInvalid(['username', 'email']);
}
public function testSelfUpdateUserValidationUnique(): void
{
$response = $this->actingAs($this->user)
->putJson('/api/user', [
'user' => [
'username' => $this->user->username,
'email' => $this->user->email,
],
]);
$response->assertOk();
}
public function testUpdateUserSetNull(): void
{
/** @var User $user */
$user = User::factory()
->state([
'bio' => 'not-null',
'image' => 'https://example.com/image.png',
])
->create();
$response = $this->actingAs($user)
->putJson('/api/user', [
'user' => [
'bio' => null,
'image' => null,
],
]);
$response->assertOk()
->assertJsonPath('user.bio', null)
->assertJsonPath('user.image', null);
}
public function testUpdateUserWithoutAuth(): void
{
$this->putJson('/api/user')
->assertUnauthorized();
}
/**
* @return array<int|string, array<mixed>>
*/
public function userProvider(): array
{
$strErrors = ['username', 'email'];
$allErrors = array_merge($strErrors, ['bio', 'image']);
return [
'required' => [[], 'any'],
'wrong type' => [[
'user' => [
'username' => 123,
'email' => null,
'bio' => [],
'image' => 123.0,
],
], $allErrors],
'empty strings' => [[
'user' => [
'username' => '',
'email' => '',
],
], $strErrors],
'bad username' => [['user' => ['username' => 'user n@me']], 'username'],
'not email' => [['user' => ['email' => 'not an email']], 'email'],
'not url' => [['user' => ['image' => 'string']], 'image'],
];
}
}
| +---- Jwt
| +---- JwtValidatorTest.php
<?php
namespace Tests\Feature\Jwt;
use App\Jwt\Builder;
use App\Jwt\Generator;
use App\Jwt\Validator;
use App\Models\User;
use Illuminate\Support\Carbon;
use Tests\TestCase;
class JwtValidatorTest extends TestCase
{
public function testValidateNullSignature(): void
{
$token = Builder::build()->getToken();
$this->assertFalse(Validator::validate($token));
}
public function testValidateInvalidSignature(): void
{
$token = Builder::build()->getToken();
$token->setUserSignature('string');
$this->assertFalse(Validator::validate($token));
}
public function testValidateHeaders(): void
{
$token = Builder::build()
->withHeader('typ', 'string')
->getToken();
$token->setUserSignature(Generator::signature($token));
$this->assertFalse(Validator::validate($token));
}
public function testValidateZeroExpiration(): void
{
$token = Builder::build()->getToken();
$token->setUserSignature(Generator::signature($token));
$this->assertFalse(Validator::validate($token));
}
public function testValidateExpiration(): void
{
$previousDay = (int) Carbon::now()->subDay()->timestamp;
$token = Builder::build()
->expiresAt($previousDay)
->getToken();
$token->setUserSignature(Generator::signature($token));
$this->assertFalse(Validator::validate($token));
}
public function testValidateNonExistentUser(): void
{
$previousDay = Carbon::now()->addDay()->unix();
$token = Builder::build()
->expiresAt($previousDay)
->withClaim('sub', 123)
->getToken();
$token->setUserSignature(Generator::signature($token));
$this->assertFalse(Validator::validate($token));
}
public function testValidateToken(): void
{
$user = User::factory()->create();
$previousDay = (int) Carbon::now()->addDay()->timestamp;
$token = Builder::build()
->expiresAt($previousDay)
->subject($user)
->getToken();
$token->setUserSignature(Generator::signature($token));
$this->assertTrue(Validator::validate($token));
}
}
+---- TestCase.php
<?php
namespace Tests;
use Illuminate\Foundation\Testing\LazilyRefreshDatabase;
use Illuminate\Foundation\Testing\TestCase as BaseTestCase;
abstract class TestCase extends BaseTestCase
{
use CreatesApplication, LazilyRefreshDatabase;
}
+---- Unit
| +---- Jwt
| +---- JwtParserTest.php
<?php
namespace Tests\Unit\Jwt;
use App\Exceptions\JwtParseException;
use App\Jwt\Parser;
use JsonException;
use PHPUnit\Framework\TestCase;
class JwtParserTest extends TestCase
{
public function testParseParts(): void
{
$this->expectException(JwtParseException::class);
Parser::parse('string');
}
public function testParseNotBase64(): void
{
$this->expectException(JwtParseException::class);
Parser::parse('string@.string#.string*');
}
public function testParseNotJson(): void
{
$this->expectException(JsonException::class);
Parser::parse('b25l.dHdv.dGhyZWU=');
}
}
webpack.mix.js
const mix = require('laravel-mix');
/*
|--------------------------------------------------------------------------
| Mix Asset Management
|--------------------------------------------------------------------------
|
| Mix provides a clean, fluent API for defining some Webpack build steps
| for your Laravel applications. By default, we are compiling the CSS
| file for the application as well as bundling up all the JS files.
|
*/
mix.js('resources/js/app.js', 'public/js')
.postCss('resources/css/app.css', 'public/css', [
//
]);
Back to Main Page