Download the PHP package goez/laravel-api-forge without Composer
On this page you can find all versions of the php package goez/laravel-api-forge. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download goez/laravel-api-forge
More information about goez/laravel-api-forge
Files in goez/laravel-api-forge
Package laravel-api-forge
Short Description A powerful command-line tool for scaffolding Laravel API projects with modern development practices and essential packages pre-configured.
License MIT
Homepage https://github.com/goez-tools/laravel-api-forge
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package laravel-api-forge
Laravel API Forge
正體中文 | English
Laravel API Forge is a powerful command-line tool that helps you quickly scaffold a complete Laravel API project with modern development practices and essential packages pre-configured. It's built on top of Laravel Zero and automates the setup of a production-ready Laravel API with optional features like Redis caching, RBAC (Role-Based Access Control), and modular architecture.
✨ Features
- 🚀 Quick Setup: Create a complete Laravel API project in minutes
- 🔧 Environment Validation: Automatically checks for required tools and versions
- 📝 Code Quality: Automatic code formatting with Laravel Pint
- 🔄 Git Integration: Step-by-step Git commits with meaningful messages
- 🐳 Docker Ready: Laravel Sail configuration with MySQL and Redis
- 🔐 Authentication: Laravel Sanctum API authentication setup
- 📊 Database: MySQL database configuration with Laravel Sail
- ⚡ Redis Cache: Optional Redis caching configuration
- 🛡️ RBAC System: Optional role-based access control with Spatie Permission
- 🔐 One-Time-Passwords: Optional OTP package for enhanced security
- 🧩 Modular Architecture: Optional Laravel Modules for modular development
- 📚 API Documentation: Spectator for OpenAPI specification testing
- 🎯 Data Transfer Objects: Laravel Data for structured data handling
- 🪝 Git Hooks: Pre-configured Git hooks for code quality checks
📋 Requirements
Before using Laravel API Forge, make sure you have the following tools installed:
- PHP 8.2+: Download PHP
- Composer: Install Composer
- Laravel Installer 5.0+:
composer global require laravel/installer - Git: Install Git
The tool will automatically validate these requirements before starting.
🚀 Installation
Install Laravel API Forge globally using Composer:
Make sure your global Composer vendor bin directory is in your $PATH. You can add this to your shell profile (.bashrc, .zshrc, etc.):
After installation, you can use the tool globally:
📖 Usage
Basic Usage
Create a new Laravel API project:
Advanced Usage with Options
Available Options
--redis: Use Redis as the cache store--rbac: Install and configure RBAC (Role-Based Access Control) package--otp: Install and configure One-Time-Passwords package--modules: Install and configure modular architecture with Laravel Modules--test-sqlite: Use SQLite for testing database (reverts to SQLite after Sail setup)
Interactive Mode
If you don't specify options, the tool will prompt you interactively:
Self-Update
Keep your Laravel API Forge up to date with the built-in self-update feature:
Note: The self-update feature only works when using the PHAR build of the tool.
🏗️ What Gets Created
The tool creates a complete Laravel API project with:
Core Setup
- Laravel 11+ with Pest testing framework
- Laravel Sanctum for API authentication
- API routes with
/v1prefix - MySQL database configuration
- Laravel Sail for Docker development environment
Optional Features (based on your choices)
Redis Cache (--redis)
- Redis cache configuration
- Removes database cache migration
- Updates environment files
RBAC System (--rbac)
- Spatie Laravel Permission package
- Team-based permissions support
- Pre-configured User model with roles
- Abilities directory structure
One-Time-Passwords (--otp)
- One-Time-Passwords package integration
- Enhanced authentication security
- Support for time-based and counter-based OTP
- Easy integration with existing authentication flow
Modular Architecture (--modules)
- Laravel Modules package
- Modular directory structure
- Vite integration for module assets
- Composer merge plugin for module dependencies
Additional Packages
- Laravel Data: For structured data transfer objects
- Spectator: For OpenAPI specification testing
- Laravel Pint: For code style formatting
Development Tools
- Pre-configured Git hooks (pre-commit, pre-push, post-merge)
- Automatic code formatting with Pint
- Environment file synchronization (.env and .env.example)
- Step-by-step Git commits for better history
- Optional SQLite testing database configuration
🔄 Development Workflow
After creating your project:
📁 Project Structure
⚙️ Configuration
The tool automatically configures:
- Database: MySQL with Laravel Sail
- Cache: Redis (if selected) or file-based
- API: Sanctum authentication with
/v1prefix - Testing: Pest with LazilyRefreshDatabase
- Code Quality: Laravel Pint with pre-commit hooks
🤝 Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
📝 License
Laravel API Forge is open-sourced software licensed under the MIT license.
🙏 Acknowledgments
- Built with Laravel Zero
- Inspired by modern Laravel development practices
- Thanks to the Laravel community for the amazing ecosystem
Happy coding! 🚀
