PostalCodeApi

Table of content

• Description
• Pre-requisites
• Getting started
• License

Description

This project is a web API to perform postal code and city related tasks (search and import). It is developed using C# and .NET core 3.1. This version includes the following features:

• User Management (auth, roles, crud)
• Importing from GeoNames
• Searching for a postal code
• Getting cities related to a postal code
• Swagger documentation
• Logging using Nlog

All the data is retrieved from GeoNames.

By default, two users are created:

• admin/123Aze@ (User with admin role)
• user/123Aze@ (User with basic user role)

You are more than welcome to use and modify the app as you please.

Pre-requisites

• ASP.NET Core 3.1

Getting started

• Clone or download the repository
• Open the project in your favorite IDE
• Check the connection string in the appsettings.json
• If you are using Visual Studio, go to the Package Manager Console and run Update-Database
• If you are using another IDE, open a terminal at the root of the project and run dotnet ef database update
• Run the application and Swagger should appear

License

MIT