Go API

0. Overview

This project falls under the category of learning and is for private purposes only.

The focus of this repo is to write backend logic for a RESTful API, focusing on GORM and Gin-Gonic. In addition to that, this repo also is using Podman as replacement for Docker.

Here's why:

• Go is awesome 😻
• I wanted to learn more about the inner workings of gin-gonic 🍸
• I wanted to learn more about the inner workings of GORM 😺
• I wanted to learn more about podman 🐳

Table of Contents

0. Overview
   • Built With
1. Getting Started
   • Prerequisites
   • Installation
2. Usage
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgments

(back to top)

Built With

This project we are using Go version go1.22.4, developed entirely on linux/amd64 system.

(back to top)

Getting Started

For a local setup, you need to have Docker and Terraform installed and have an official Docker container for the GitLab community edition running. If you have not yet installed these items, please take the following steps:

Prerequisites

• Install Docker

  sudo apt install gnome-terminal
  sudo apt update
  sudo apt install ./docker-desktop-<version>-<arch>.deb
  

• Run an instance of PostgreSQL

  docker run --name postgres \
    -e POSTGRES_PASSWORD=$PASSWORD \
    -e POSTGRES_USER=$USER \ 
    -e POSTGRES_DB=$DATABASE_NAME \ 
    -p 5432:5432 \ 
    -d postgres
  

Installation

Usage

There is no particular usage yet.

(back to top)

Roadmap

• Add License
• Add Readme
• Extend logic to include all CRUD operations
• Containerize the entire logic with Podman
• Set up a compose project to run project with all its dependencies with Podman compose

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

This is my first project in an attempt in giving back to the community. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Philip Weinmann - [email protected]

Project Link: https://github.com/weinmann-phil/go-api

(back to top)

Acknowledgments

I am grateful to the people that provided the following resources, which I have used to create this project.

• README template
• GitHub - withsilasogar - REST API Tutorial with Go

(back to top)

Referecenes

• Go - Gin
• Go - Gorm