ice-felix-starter
v2.1.1
Published
ICE Felix Starter - Complete development environment installer for Laravel, Flutter, and Supabase projects
Maintainers
Readme
ICE Felix Starter 🚀
Complete development environment installer for Laravel, Flutter, and Supabase projects
A powerful CLI installer that sets up a complete full-stack development environment with Laravel backend, Flutter frontend, and Supabase database - all configured and ready to use!
🎯 What You Get
- Laravel Backend - PHP API with MySQL database
- Flutter Frontend - Cross-platform web and mobile app
- Supabase Database - Real-time database with authentication
- Docker Services - MySQL and Redis containers
- Environment Configuration - Automated .env file setup
- Git Integration - Repository cloning and configuration
📦 Installation
Global Installation (Recommended)
npm install -g ice-felix-starterOne-time Run (No Installation)
npx ice-felix-starter🚀 Usage
After installation, simply run:
ice-felixOr with the full name:
ice-felix-starterThe installer will guide you through:
- System Requirements Check - Verifies required tools
- Project Configuration - App name, domain, credentials
- Repository Setup - Clones Laravel and Flutter projects
- Supabase Integration - Sets up database and functions
- Docker Configuration - Prepares container services
- Environment Setup - Generates configuration files
🛠️ Prerequisites
Required Tools
- Git - Version control
- Python 3.8+ - CLI runtime
- Docker - Container platform (for Supabase functions)
Optional Tools (Auto-detected)
- PHP & Composer - Laravel development
- Flutter - Mobile app development
- Supabase CLI - Database management
📋 Features
✅ Automated Setup
- Smart System Detection - Checks for required tools
- Interactive Configuration - Guided setup process
- Docker Integration - Automatic container setup
- Environment Generation - Complete .env file creation
✅ Supabase Integration
- Database Migrations - Automatic deployment
- Edge Functions - TypeScript serverless functions
- Authentication Setup - User management ready
- Real-time Features - Live data synchronization
✅ Development Ready
- Laravel API - RESTful backend with MySQL
- Flutter App - Cross-platform frontend
- Docker Compose - Multi-container orchestration
- Git Repositories - Version control integration
🎛️ Configuration Options
The installer will prompt for:
- Project Name - Your application identifier
- Installation Directory - Where to create the project
- Domain Address - Your app's URL
- Admin Credentials - Initial admin user
- API Keys - Supabase and external service keys
📁 Project Structure
your-project/
├── backend/ # Laravel API
│ ├── app/ # Application code
│ ├── database/ # Migrations & seeds
│ └── .env # Environment config
├── frontend/ # Flutter app
│ ├── lib/ # Dart source code
│ ├── assets/ # Images & resources
│ └── pubspec.yaml # Dependencies
├── cloud/ # Supabase project
│ ├── supabase/ # Database & functions
│ │ ├── functions/ # Edge functions
│ │ └── migrations/ # Database schema
│ └── config.toml # Supabase config
└── docker-compose.yml # Container orchestration🐳 Docker Support
The installer includes smart Docker integration:
- Automatic Detection - Checks if Docker is running
- Function Deployment - Supabase edge functions require Docker
- Graceful Fallback - Clear instructions if Docker unavailable
- Manual Options - Commands for manual deployment
🔧 Advanced Usage
Manual Python Execution
If you prefer to run the Python script directly:
# Clone the repository
git clone https://github.com/ICE-Felix/ice-felix-starter.git
cd ice-felix-starter
# Install dependencies
pip install -r requirements.txt
# Run installer
python3 install_cli.pyDevelopment Mode
# Install in development mode
git clone https://github.com/ICE-Felix/ice-felix-starter.git
cd ice-felix-starter
npm install
npm start🆘 Troubleshooting
Common Issues
Command not found: ice-felix
# Reinstall globally
npm uninstall -g ice-felix-starter
npm install -g ice-felix-starterPython not found
# Install Python 3.8+
# macOS: brew install python3
# Ubuntu: sudo apt install python3
# Windows: Download from python.orgDocker not running
# Start Docker Desktop
# The installer will guide you through this📞 Support
- Issues: GitHub Issues
- Documentation: Wiki
- Website: icefelix.com
🤝 Contributing
We welcome contributions! Please see our Contributing Guidelines.
📄 License
MIT License - see LICENSE file for details.
Made with ❤️ by the ICE Felix Team
Transform your development workflow with a complete full-stack starter in minutes!
