go-api-template

module
v0.0.0-...-48c6f6e Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 20, 2024 License: MIT

README

Getting Started

  1. Download the needed packages task install
  2. Create and populate the app.env file with the needed environment variables, can be found in app.env.example

Dependencies, Tools and Infra

First, install the Taskfile to run the tasks and provide other tools:

Taskfile:

https://taskfile.dev/installation/

go install github.com/go-task/task/v3/cmd/task@latest

Then, install the all other tools with the command:

task setup-tools

Now, create docker containers with dependencies:

task setup-infra

Deployment

[PENDING]

  • Checar GO_ENV para deploy

https://railway.app/pricing

TODO

  • refactor log
  • Add observability
  • Add conversational id to logs
  • Add CI/CD
  • Change Http layer for echo
  • Refactor sqlutils to enable interface to unit tests
  • Refactor rediutils to enable interface to unit tests
  • Add tests
  • Refact logger using logruss
  • Add simple auth using package and an interface to able to setup your own auth or clerk

Directories

Path Synopsis
cmd
Package docs Code generated by swaggo/swag.
Package docs Code generated by swaggo/swag.
internal
app
pkg
redisutils
Package redisutils is a generated GoMock package.
Package redisutils is a generated GoMock package.
sqlutils
Package sqlutils is a generated GoMock package.
Package sqlutils is a generated GoMock package.
transcriber
Package transcriber is a generated GoMock package.
Package transcriber is a generated GoMock package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL