Pet Search

A restful API to search available pets for adaption within a given zip code. Users can also enter a zipcode or enter a set of coordinates to get the city's information in order to search for available pets.

Web API was made with ASP.NET Web Api and .NET 8.

Angular application hosted at Vercel, React application hosted at Netlify and ASP.NET Web API hosted at Microsoft Azure.

Pet Search Angular Application GitHub Repository

Pet Search React Application GitHub Repository

Live Demo

Note: Server response may take around 10 seconds during a cold start when the server is reactivated after 10 minutes of inactivity. I'm considering upgrading the server to 'always on' on Microsoft Azure in the future.

ASP.NET Live Swagger UI

Angular Application Live Demo

React Application Live Demo

Preview

Technology Stack

• Developed with C# and ASP.NET Web API
• Tested with Xunit
• Hosted at Microsoft Azure Web App Deployment
• Token storage with MySQL
• API Documentation with OpenApi/Swagger
• Adoptable pet retrieval with PetFinder API
• Location authentication with MapBox Geolocation API

Angular Application

Angular GitHub Source Code

React Application

I am no longer serving the React files from ASP.NET. I have decided to host the React application at Netlify instead for a better user experience and separation of concerns. I have also stopped providing updates for the React application. All client updates will be done through the Angular application.

React GitHub Source Code

Local Development Set Up

Note: This set up assumes you have obtained keys from PetFinder API and MapBox API.

Required Dependencies

• .NET SDK

Running the Production Build

1. Clone this repository:

git clone https://github.com/AmielCyber/PetSearch

2. After cloning this repository, go to the repository directory:

cd PetSearch

ASP.NET Setup

Note: You must set a MySQL database and create a username and password with DBManager privileges. You must also create a connection for MySQL.

DROP
USER if exists 'your-user-name'@'localhost';

CREATE
USER 'your-user-name'@'localhost' IDENTIFIED BY 'your-password';

GRANT ALL PRIVILEGES ON * . * TO
'your-user-name'@'localhost';

Note: You must also get access tokens from MapBox and PetFinder API

In the file: appsettings.development.json replace the empty {} with your own MySQL settings:

"DefaultConnection": "server=localhost;port=3306;database={yourDatabaseName};user={yourUserName};password={yourPassword}"

1. Go to the API application of the ASP.NET project:

cd ./PetSearch.API

2. Register your keys:

dotnet user-secrets init
dotnet user-secrets set "PetFinder:ClientId" "your_client_id"
dotnet user-secrets set "PetFinder:ClientSecret" "your_client_secret"
dotnet user-secrets set "MapBox:AccessToken" "your_access_token"

3. Download and install NuGet dependencies:

   dotnet restore

4. Build the .NET application:

   dotnet build

5. Create MySQL database:

   dotnet ef database update -p ../PetSearch.Data

6. Run tests:

   dotnet test

7. Run the application:

   dotnet run

   1. In the terminal check what port the application is using:

   http://localhost:{port}
   

   2. Open your browser and go to http://localhost:{port}/swagger/index.html to test the app endpoints.
   3. Close the application by entering ctrl c on your terminal where you ran dotnet run