metafroliclabs/laravel-kit

This project provides a starter boilerplate for Laravel applications with essential authentication, profile management, and content page routes.

v1.0.1 2025-04-16 09:25 UTC

Requires

• php: ^8.1
• guzzlehttp/guzzle: ^7.2
• kreait/firebase-php: ^7.16
• laravel/framework: ^10.10
• laravel/sanctum: ^3.3
• laravel/tinker: ^2.8
• stripe/stripe-php: ^14.8

Requires (Dev)

• fakerphp/faker: ^1.9.1
• laravel/pint: ^1.0
• laravel/sail: ^1.18
• mockery/mockery: ^1.4.4
• nunomaduro/collision: ^7.0
• phpunit/phpunit: ^10.1
• spatie/laravel-ignition: ^2.0

MIT

• framework
• boilerplate
• laravel

README

Laravel Starter Boilerplate

This project provides a starter boilerplate for Laravel applications with essential authentication, profile management, and content page routes.

Installation

1. Create a new project using Composer:

   composer create-project metafroliclabs/laravel-kit

2. Setup environment:

   • Configure database and application settings.

3. Run migrations:

   php artisan migrate

4. Install Passport (if required for Sanctum):

   php artisan passport:install

5. Start the application:

   php artisan serve

Available Routes

Authentication Routes

Method	Endpoint	Controller	Description
POST	/signup	AuthController	User signup
POST	/login	AuthController	User login
POST	/logout	AuthController	User logout (auth)

Middleware: auth:sanctum is required for /logout.

Password Recovery Routes

Method	Endpoint	Controller	Description
POST	/forget-password	ForgetPasswordController	Request password reset
POST	/verify-code	ForgetPasswordController	Verify reset code
POST	/set-password	ForgetPasswordController	Reset password

Profile Management (Protected)

Method	Endpoint	Controller	Description
GET	/get-profile	ProfileController	Get user profile
POST	/edit-profile	ProfileController	Edit user profile
POST	/change-password	ProfileController	Change password
GET	/notifications/all/list	ProfileController	List all notifications
GET	/notifications/read/list	ProfileController	List read notifications
GET	/notifications/unread/list	ProfileController	List unread notifications
GET	/notifications/unread/count	ProfileController	Get unread notification count
POST	/notifications/{id}	ProfileController	Mark a single notification as read/unread
POST	/notifications/read	ProfileController	Mark all notifications as read

All routes require auth:sanctum middleware.

Page Routes (Protected)

Method	Endpoint	Controller	Description
POST	/contact-us	PageController	Submit contact form
GET	/content	PageController	Get static content

auth:sanctum middleware is required.

License

This project is licensed under the MIT License.