Skip to content
hamza-topoPublic

About

petmingle project (dating,petsetting,adoption)

Resources

Security policy

Stars

1 star

Watchers

1 watching

Forks

Latest commit

 

History

693 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Laravel Forge Site Deployment Status

Pet Matching API Development Workspace

👋 Introduction

Welcome to the Pet Matching API development workspace. This space serves as a central hub for all documentation related to the API, providing a comprehensive guide for our team looking to integrate and understand the functionalities it offers.

🚀 Getting Started with this Workspace

Reference Collections

Explore the following collections to gain insights into the capabilities of our Pet Matching API:

Feel free to add #reference collections for your specific services to enhance the documentation.

Blueprint Collections

Check out our self-service collections, such as:

  • RESTful API Basics Collection: This collection demonstrates workflows supported by our API using the fake-store API. You can directly send requests to observe and understand these workflows.

Consider adding #blueprint collections for essential workflows managed by your team.

🛟 Help and Support

If you have any questions, suggestions, or need assistance, please reach out to your manager or any member of the Engineering team.

🚧 API Details

  • Built with: Laravel 13
  • Requires: PHP 8.4
  • Note: Additional features will be added as the API evolves.

🐳 Docker Development

This project includes a local Docker stack for Laravel 13:

  • nginx serves the app on http://localhost:8000
  • app runs PHP 8.4 FPM with Composer
  • mysql runs MySQL 8
  • node runs the React Vite development server on http://localhost:5174 when the frontend profile is enabled
  • mailpit captures local emails on http://localhost:8025

First run

cp .env.example .env
docker compose up -d --build
docker compose exec -u www-data app php artisan key:generate
docker compose exec -u www-data app php artisan migrate --seed

Open Laravel at http://localhost:8000. For React, copy frontend/.env.example to frontend/.env.local, then run docker compose --profile frontend up -d node and open http://localhost:5174. The browser-facing API URL and exact CORS origins must match; see frontend setup.

Useful commands

docker compose exec -u www-data app php artisan test
docker compose exec -u www-data app php artisan migrate:fresh --seed
docker compose exec -u www-data app composer install
docker compose run --rm node npm run typecheck
docker compose --profile frontend up node

PHP quality gates

Before opening or updating a backend pull request, run:

docker compose exec -u www-data app composer quality

The combined check runs Laravel Pint in verification mode and Larastan/PHPStan at level 5 against app/.

To apply formatting locally:

docker compose exec -u www-data app composer format

See PHP quality gates for the static-analysis baseline policy and individual commands.

Notes

  • Composer dependencies live in a Docker named volume, so the host does not need PHP installed.
  • Node dependencies live in a Docker named volume, so the host does not need Node installed.
  • Database data is persisted in the mysql_data Docker volume.
  • Local overrides can be placed in docker-compose.override.yml, which is intentionally ignored by git.

📱 Consumption Platforms

This API is designed to be consumed by a mobile app and a React/TypeScript frontend in frontend/.

🌟 Contributing and Future Plans

We welcome contributions and feedback to enhance the Pet Matching API. As we move forward, we plan to expand its capabilities and integrations with additional platforms.

Thank you for being a part of our API development journey!

About

petmingle project (dating,petsetting,adoption)

Resources

Security policy

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages