Skip to content

Latest commit

 

History

History
71 lines (42 loc) · 1.83 KB

README.md

File metadata and controls

71 lines (42 loc) · 1.83 KB

ADDRESS SERVICE

Microservice Description

The Address Service is a proof-of-concept microservice written in Go, utilizing the Gin framework and interacting with a PostgreSQL database. This microservice is designed to provide seamless CRUD (Create, Read, Update, Delete) operations for address entities. Whether you need to create new addresses, retrieve individual or multiple addresses, update existing records, or delete entries.

Technologies Used:

  • Go Language: The microservice is implemented in Go, leveraging its efficiency and performance benefits.

  • Gin Framework: Built on top of Go, Gin provides a lightweight and fast HTTP web framework, making it ideal for building RESTful APIs.

  • PostgreSQL Database: The microservice interacts with a PostgreSQL database to store and retrieve address data.

Purpose:

This microservice serves as a proof of concept, demonstrating the capabilities of Go, Gin, and PostgreSQL in the context of a RESTful API for managing address data.

Prerequisites

Before you start, ensure that you have Golang installed on your machine. Follow the official documentation for installation instructions.

Getting Started

  1. Clone the repository:

    git clone https://github.com/JSharles/address_service_poc.git
cd address_service_poc

  2. Install dependencies:

go mod tidy
  1. Start the project:
go run main.go

OR

  1. Build the project:
go build -o <any-name-you-like>

AND

5.Execute the binary :

./the-name-you-picked

6.Run tests:

make test

Swagger Documentation

After starting the microservice locally, you can access the Swagger documentation at:

Swagger Documentation