Getting Started

Get up and running with MyWarranties in 5 minutes.

Prerequisites

Before you begin, ensure you have:

• PHP 8.3 or higher
• Composer 2.0 or higher
• MySQL 8.0 or PostgreSQL 13+
• Git for version control

Quick Installation

1. Clone the Repository

git clone https://github.com/yourusername/mywarranties-backend.git
cd mywarranties-backend

2. Install Dependencies

composer install

3. Configure Environment

cp .env.example .env

Edit .env with your settings:

DATABASE_URL="mysql://user:password@127.0.0.1:3306/mywarranties"
JWT_PASSPHRASE=your_secure_passphrase
MAILER_DSN=smtp://resend:re_your_api_key@smtp.resend.com:587

4. Generate JWT Keys

php bin/console lexik:jwt:generate-keypair

5. Create Database

php bin/console doctrine:database:create
php bin/console doctrine:migrations:migrate

6. Start Server

symfony server:start
# or
php -S localhost:8000 -t public/

Your First API Call

Get a JWT Token

curl -X POST http://localhost:8000/api/login \
  -H "Content-Type: application/json" \
  -d '{
    "email": "test@example.com",
    "password": "password123"
  }'

Response:

{
  "token": "eyJ0eXAiOiJKV1QiLCJhbGc...",
  "user": {
    "id": 1,
    "email": "test@example.com"
  }
}

Create a Product

curl -X POST http://localhost:8000/api/products \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "iPhone 15",
    "brand": "Apple",
    "category": "Electronics",
    "purchaseDate": "2024-01-15",
    "warrantyPeriodMonths": 12
  }'

Create a Warranty Claim

curl -X POST http://localhost:8000/api/claims \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "productId": 1,
    "description": "Screen not working properly"
  }'

Next Steps

• Email Integration - Configure email and webhooks
• API Reference - Explore all endpoints
• CLI Commands - Learn console commands
• What is MyWarranties? - Understand the system