https://github.com/descent098/chirps
A walkthrough of the laravel bootcamp
https://github.com/descent098/chirps
Last synced: 3 months ago
JSON representation
A walkthrough of the laravel bootcamp
- Host: GitHub
- URL: https://github.com/descent098/chirps
- Owner: Descent098
- Created: 2024-07-24T19:18:20.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-24T20:45:11.000Z (over 1 year ago)
- Last Synced: 2025-09-14T07:51:42.581Z (4 months ago)
- Language: PHP
- Homepage: https://bootcamp.laravel.com/blade/installation
- Size: 408 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Chirps
This is my personal repo for working on the [laravel bootcamp](https://bootcamp.laravel.com/introduction) (specifically the [blade version](https://bootcamp.laravel.com/blade/installation)).
## Running
You can run the docker file with just `docker compose up`
or you can install [Laravel Sail](https://laravel.com/docs/11.x/sail) and run using that
## Architecture overview
Routing is handled by `/routes/web.php`, which in this setup allows for each model to have it's own Controller (in `app/Http/Controllers/Controller.php`).
The Controllers implement the standard CRUD operations, and when the routers call the methods the controller can then decide (based on return type) to:
- Respond natively with a `Illuminate\Http\Response` type
- Respond by passing off to a view with a `Illuminate\View\View` type
- Respond via a redirect to a view or URL with a `Illuminate\Http\RedirectResponse` type
From there we can gate certain actions behind policies found in `/app/Policies/Policy.php`. This can then be added to the Controller routes using `Illuminate\Support\Facades\Gate`. For example:
```php
Gate::authorize('update', $modelInstance);
```
Will then go to `Policy.php`, check the `update()` method in the class to see if the user has access, and then only continue if they do.
If a view is being used then that view can be found at `/resources/views//.blade.php`. For example if `chirps.index` is the view being returned in the controller then `/app/resources/views/chirps/index.blade.php` is run, if `chirps.edit` is run, then change index in the last route to edit (`/app/resources/views/chirps/edit.blade.php`).
So in abstract:
```mermaid
flowchart TD
User((User)) & a[[routes/web.php]] & b[["app/Http/Controllers/{{model}}Controller.php"]] & c[["/app/Policies/{{model}}Policy.php"]] & d[["/resources/views/{{model}}/{{viewname}}.blade.php"]]
User --request--> a --Forwards to --> b
b --> e{if gated} -- Yes --> c
e -- No -->d
c--If has access--> d
c--If does not have access --> User
d --> User
```
Here is a more concrete example of getting `chirps.index` (a GET at `/chirps`):
```mermaid
flowchart TD
User((User)) & a[[routes/web.php]] & b[["app/Http/Controllers/ChirpController.php"]] & d[["/resources/views/chirps/index.blade.php"]]
User --request GET /chirps--> a --Forwards to --> b --If logged in--> d
d --> User
```
Here is another with a protected view `chirps.edit` (A GET at `/chirps/{chirp}/edit`):
```mermaid
flowchart TD
User((User)) & a[[routes/web.php]] & b[["app/Http/Controllers/ChirpController.php"]] & c[["/app/Policies/ChirpPolicy.php"]] & d[["/resources/views/chirps/edit.blade.php"]]
User --request GET /chirps/{chirp}/edit--> a --Forwards to --> b
b --> e{Gated} -- Yes --> c
c--If has access--> d
c--If does not have access (error) --> User
d --> User
```
## Helpful commands
- `php artisan migrate:fresh --seed`: Reset DB and rerun seeding