Skip to content

Latest commit

 

History

History
24 lines (21 loc) · 1.09 KB

README.md

File metadata and controls

24 lines (21 loc) · 1.09 KB
Raw

Pet Match REST API

Find your friend.

FRs (Functional requirements)

  • Should be able to register a pet.
  • Should be able to list every pet able to be adopted in a city.
  • Should be able to filter pets by their characteristics.
  • Should be able to view details of a pet for adoption.
  • Should be able to register as an organization.
  • Should be able to login as an organization.

BRs (Business rules)

  • To list pets, the city should be provided.
  • An organization needs to have an address and a WhatsApp number.
  • A pet should be linked to an organization.
  • The user that wants to adopt a pet, should get in contact with the organization by his WhatsApp number.
  • Every filter, expect the city, is optional.
  • For an organization to access the app as an ADMIN, they should be logged in.

NFR (Non-functional requirements)

  • The organizations password should be encrypted.
  • The data should be stored in a PostgreSQL database.
  • Every data list should be paginated with 20 items per page.
  • The organization should be identified by a JWT token.