https://github.com/starlingvibes/hngx-be-task_2

My Golang solution to the second task in the Backend Track of the HNGX Internship programme.
https://github.com/starlingvibes/hngx-be-task_2

gin golang mongodb

Last synced: about 1 month ago
JSON representation

My Golang solution to the second task in the Backend Track of the HNGX Internship programme.

• Host: GitHub
• URL: https://github.com/starlingvibes/hngx-be-task_2
• Owner: starlingvibes
• Created: 2023-09-12T14:18:29.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-12T17:55:29.000Z (over 1 year ago)
• Last Synced: 2023-09-12T23:28:10.429Z (over 1 year ago)
• Topics: gin, golang, mongodb
• Language: Go
• Homepage: https://hngx-be-task-2.onrender.com/api
• Size: 12.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# HNGX-BE-Task_2

My Golang solution to the second task in the Backend Track of the HNGX Internship programme.

## :dart: Objective

You are to build a simple REST API capable of CRUD operations on a "person" resource, interfacing with any database of your choice. Your API should dynamically handle parameters, such as adding or retrieving a person by name. Accompany the development with UML diagrams to represent your system's design and database structure.

## 🎯 Requirements

The information required includes:

- Functional REST API: The API should successfully perform all CRUD operations.

- Modelling Diagrams: Clear and accurate UML and E-R diagrams should be provided.

- Effective Testing Script: The script should successfully test all the CRUD operations without manual intervention.

- Dynamic Parameter Handling: The API should correctly handle and respond to different parameters provided.

- GitHub Repository: Repository should be well-organized, contain all necessary files, and be publicly accessible.

- Detailed Documentation: Documentation should provide clear guidance on how to use the API, including setup, request/response formats, and sample usage.

## 🎯 Documentation

The full documentation can be found [here](https://github.com/starlingvibes/HNGX-BE-Task_2/blob/main/DOCUMENTATION.md).

## 🎯 Testing the application

The postman collection can be found [here](https://github.com/starlingvibes/HNGX-BE-Task_2/blob/main/documentation/HNGX-BE-Task_2.postman_collection.json).

## UML Diagram

The Unified Modelling Language diagram can be found [here](https://github.com/starlingvibes/HNGX-BE-Task_2/blob/main/models/uml_diagram.png).

![UML Diagram](https://github.com/starlingvibes/HNGX-BE-Task_2/blob/main/models/uml_diagram.png?raw=true)