Quick Start Guide

Prerequisites

Before starting, ensure you have:

• Docker installed on your machine - Install Docker
• Composer installed on your machine - Install Composer

Installation Steps

1. Install GEMVC with Composer

Go to your project folder and run:

composer require gemvc/library

Tip: Be sure you have installed Composer and PHP 8.1 or higher

2. Initialize Your Project

Run the init command to set up your project:

php vendor/bin/gemvc init

info: You can choose webserver type in the prompt after init command

3. Build and Run with Docker

Start your development environment:

docker compose up -d --build

info: GEMVC comes with a ready-to-use Docker setup (PHP, MySQL, Redis, PHPMyAdmin)

4. Test Your Installation

Open your browser and visit:

http://localhost:9501

Database Setup

1. Initialize Database

Create the database in MySQL:

php vendor/bin/gemvc db:init

info: Change database name in .env file before running this command if needed

2. Migrate User Table

php vendor/bin/gemvc db:migrate UserTable

info: To see table structure: php vendor/bin/gemvc db:describe users

Create Your First API

1. Generate CRUD API

Generate a complete CRUD API for a resource:

php vendor/bin/gemvc create:crud Product

This creates:

2. Create Table in Database

Generate table based on your Table-Layer:

php vendor/bin/gemvc db:migrate ProductTable

Tip: To see table structure: php vendor/bin/gemvc db:describe products

Test Your API

Try your endpoint:

http://localhost:9501/product/list

Tip: OpenSwoole: localhost:9501 | Apache: localhost:80

Or visit the auto-generated API docs.

Sample response:

{ 
"response_code": 200,
"message": "OK",
"count": 0,
"service_message": "list of products fetched successfully"
"data": [],
}

Next Steps

• Configuration Guide
• Architecture Overview
• API Development