Installation

Get started with ApnaPHP in seconds! Our official boilerplate includes everything you need to start building modern PHP applications.

Requirements

Before you begin, ensure you have the following installed:

• PHP 8.1+ - ApnaPHP requires PHP 8.1 or higher
• Composer - For dependency management
• Database - MySQL, PostgreSQL, SQLite, or MongoDB (optional for getting started)

Quick Start

1. Create New Project

composer create-project alsocoder/apnaphp my-app
cd my-app

2. Configure Environment

cp .env.example .env

Edit the .env file with your database settings:

DB_DRIVER=mysql
DB_HOST=localhost
DB_PORT=3306
DB_DATABASE=my_database
DB_USERNAME=root
DB_PASSWORD=password

3. Start Development Server

php apna serve

Visit http://localhost:3000 to see your application! 🎉

What You Get

The boilerplate includes:

• ✅ Complete ApnaPHP Framework (everything included)
• ✅ Ready-to-use project structure
• ✅ Pre-configured environment files
• ✅ Sample welcome page
• ✅ Database configuration
• ✅ CLI tools ready to use

Project Structure

my-app/
├── app/
│   └── page.apna.php          # Your main page
├── config/
│   ├── app.php               # App configuration
│   └── database.php          # Database configuration
├── models/                   # Your models directory
├── public/
│   └── index.php            # Entry point
├── storage/                  # Storage directory
├── .env.example             # Environment variables template
├── composer.json            # Dependencies (framework auto-included)
└── apna                     # CLI executable

No Manual Setup Required

Unlike other frameworks, you don't need to:

• ❌ Manually download the framework
• ❌ Set up complex project structure
• ❌ Configure routing manually
• ❌ Install additional dependencies

Everything is pre-configured and ready to use! 🚀

Next Steps

• Configuration - Learn about environment setup
• Project Structure - Understand the framework architecture
• Your First API - Create your first API endpoint