Backend API for Pet Adoption App (Version 2.0)

Students: João Vitor Donaton
Instructor: Vinicius Godoy
Link to presentation video (PORTUGUESE)
Link to powerpoint presentation (PORTUGUESE)

Compilation Instructions:

• Clone repository
• Create file named apikeys.properties in src/main/resources, with the property keys.googleApi (key to access google Geocoding API)
• Configure database (MySQL) through application.properties.
  • spring.datasource.url=DATABASE_URL
  • spring.datasource.username=USERNAME
  • spring.datasource.password=PASSWORD
• Use the command ./mvnw spring-boot:run or use Intellij to compile and run

Configurations:

• apikeys.properties (not in git)
  • Property: keys.google-api (google API key to query location data)
• bootstrapdata.properties
  • Data for database bootstrapping
  • Details in BootstrapSettings.java
• location.properties
  • Third party API URLs
  • LocationUtils.java replaces placeholder data (ADDRESS, KEY e o CEP)
• messages.properties
  • Standardized error messages to return in case of exceptions
• security.properties
  • Secret e Issuer to generate JWT tokens

The API features endpoints for:

• Account management and authentication
• Creation of profiles with location data (google geocoding API and viacep API) and adoption preferences
• Pet enrollment and management
• Matching system to find pets that fit the users profile
• Sending and management of adoption requests for pets
• Some endpoints were removed in version 2.0 (I chose to focus on other features, as implementing these endpoints is basically just doing more of the same)
  • ~~Creation of NGOs, government organizations and user organizations~~~
  • Creation of adoption campaigns
  • Adoption campaign blogposts