https://github.com/kenmwaura1/go-todo-api

A REST api in Go
https://github.com/kenmwaura1/go-todo-api

fiber-framework golang gorm postgresql

Last synced: 6 months ago
JSON representation

A REST api in Go

• Host: GitHub
• URL: https://github.com/kenmwaura1/go-todo-api
• Owner: KenMwaura1
• License: mit
• Created: 2021-11-26T15:05:37.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-12-13T04:03:13.000Z (almost 4 years ago)
• Last Synced: 2025-02-07T16:39:24.162Z (8 months ago)
• Topics: fiber-framework, golang, gorm, postgresql
• Language: Go
• Homepage:
• Size: 31.3 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# go-todo-api

[![Docker Image CI](https://github.com/KenMwaura1/go-todo-api/actions/workflows/docker-image.yml/badge.svg)](https://github.com/KenMwaura1/go-todo-api/actions/workflows/docker-image.yml)

A REST api in Go utilizing Fiber, Postgres and docker as a dev tool.

Allows user to create and retrive todos

## Installation

Ensure you have the following installed:

* [Go](https://golang.org/doc/install)

* [Fiber](https://github.com/gofiber/fiber)

* [Postgres](https://www.postgresql.org/download/)

* [Docker](https://www.docker.com/)

* [Docker Compose](https://docs.docker.com/compose/install/)

## Usage

To run the api:

```shell

docker-compose up

```

## Endpoints

You can use the swagger file to check and test the endpoints we just created for this app.

To test the endpoints, I recommend you to download an HTTP client like [Insomnia](https://insomnia.rest/).

## Contribute

Please feel free to contribute!