Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix some typos in README #6

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix some typos in README #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,28 +7,28 @@ An awesome boilerplate for your next Laravel 9 based API. It's only goal is to s
## Features 🍭

### REST API Best Practices
We baked in all the best REST API practices in terms of structuring your API, naming conversations, HTTP methods, responses and optimizations
We baked in all the best REST API practices in terms of structuring your API, naming conventions, HTTP methods, responses, and optimizations.

### Concrete examples
We all like to learn by examples and that's why the boilerplate comes with a concrete example that include everything from folder structure, routes to naming controllers
We all like to learn by examples and that's why the boilerplate comes with a concrete example that include everything from folder structure, routes to naming controllers.

### Scaffolding Artisan command
Tired of manually creating controllers, resources, test and form requests each time for new API endpoints. We were too. That's why we added a command that does all of that for you. Just run `php artisan treblle:make` and you get everything you need in a second</dd>
Tired of manually creating controllers, resources, test and form requests each time for new API endpoints? We were too. That's why we added a command that does all of that for you. Just run `php artisan treblle:make` and you get everything you need in a second.</dd>

### Built-in versioning
Building a versioning system that scales is always hard and that's why we built in a robust versioning system that is easy to use and can grow with the project</dd>
Building a versioning system that scales is always hard and that's why we built in a robust versioning system that is easy to use and can grow with the project.</dd>

### Single responsibility controllers
The boilerplate uses single responsibility controllers that make it painfully obvious what's going on and can be used with different versions
The boilerplate uses single responsibility controllers that make it painfully obvious what's going on and can be used with different versions.

### Models, migrations and factories
We built two tables Users and Posts and defined everything you might need on a database and model level
We built two tables Users and Posts and defined everything you might need on a database and model level.

### Sanctum authentication
Built in Laravel Sanctum authentication included in the boilerplate.

### Magical UUID trait
Want to use UUIDs but find it to much work just use our built in `InteractsWithUuid` trait and have fun with UUIDs
Want to use UUIDs but find it to much work just use our built in `InteractsWithUuid` trait and have fun with UUIDs.

### Spawn a new user quickly
Easily create a new user without messing around with database clients or CRUD systems by using our custom command `php artisan user:create`
Expand Down