Dotnet Pet Search

A user-friendly API allows for the search of available pets for adoption within a specific zip code. Users can also input a zip code or a set of coordinates to obtain the city’s information, enabling them to search for available pets in that area.

The Web application was developed using ASP.NET Web API and .NET 8. This application has been rewritten and updated to .NET 8 from .NET 7 for better performance and to utilize Object-Oriented Design principles for easier maintenance.

Original Repository

The Angular application is hosted on Vercel, the React application is hosted on Netlify, and the ASP.NET Web API is hosted on 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 API Library Specification with 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

Note:

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
• Docker Container for MySQL

Running the Production Build

1. Clone this repository:

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

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

cd DotnetPetSearch

MySql Setup

You must set a MySQL database and create a username and password. You can do that with a docker container with a MySQL 8.0. To set up the container enter the following in your terminal:

docker run -d - e MYSQL_ROOT_PASSWORD=secret -e MYSQL_DATABASE=petsearchdb --name petsearchdb -p 3307:3306 mysql: 8.0

You may replace the password and the database name to your own like, but you will also need to update those values in appsettings.Development.json

Get API Tokens

You must get access tokens from MapBox and PetFinder API

PetFinder API

MapBox Geolocation API

ASP.NET Setup

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

cd ./DotnetPetSearch.API

2. Register your PetFinder and MapBox keys using user-secrets

dotnet user-secrets init
dotnet user-secrets set "PetFinderCredentials:ClientId" "your_client_id"
dotnet user-secrets set "PetFinderCredentials: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 ../DotnetPetSearch.Data

6. Run tests:

   dotnet test

7. Run the application:

   dotnet run

   • In the terminal check what port the application is using and click or copy the link and it should direct you to the Swagger UI Application

   http://localhost:{port}