Loyalty App (Laravel 13)

Simple loyalty API for users, achievements, and badges.

Requirements

• PHP 8.3+
• Composer 2+
• MySQL or MariaDB

Setup on a new machine

1) Clone and checkout the backend branch

git clone <your-repo-url>
cd loyalty-app
git checkout backend

2) Install dependencies

composer install

3) Create env file and app key

cp .env.example .env
php artisan key:generate

4) Configure database

Default .env values:

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=loyalty_app
DB_USERNAME=root
DB_PASSWORD=

Create the DB:

CREATE DATABASE loyalty_app CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;

5) Run migrations and seeders

php artisan migrate --seed

Seeded data includes:

• achievements
• badges
• users

6) Start the app

php artisan serve

API base URL: http://127.0.0.1:8000/api

API endpoints

• GET /api/users
  Paginated users, wrapped in Laravel resource response.

• POST /api/users/{user}/purchase
  Request body:

  { "amount": 1500 }

  Response: 201 with {"data":[]}.

• GET /api/users/{user}/achievements
  Response includes:

  • unlocked_achievements
  • next_available_achievements
  • current_badge
  • next_badge
  • remaining_to_unlock_next_badge