tapir-app

module
v0.0.0-...-bdb9bc1 Latest Latest
Warning

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

Go to latest
Published: Oct 2, 2023 License: MIT

README

Tapir App Example

Goals of this app: https://bmdavis41902.notion.site/Tapir-App-Goals-d33eb7f8a5a94725af3f07cae2ecd86c

Getting Started

  1. Ensure you have Go installed & download task https://taskfile.dev/installation/
  2. Download the needed packages task install
  3. Create and populate the app.env file with the needed environment variables, can be found in app.env.example
  4. Start the dev server task dev
  5. View the API docs at http://localhost:8080/swagger

Note: for Windows users, update your bin & cmd string to include the .exe extension in .air.toml file before running task dev

bin = "./tmp/main.exe"
cmd = "go build -o ./tmp/main.exe cmd/http/main.go"

Deployment

Railway is the recommended deployment platform, but any platform that supports Docker should work.

Reference Video: https://youtu.be/C3cIIz73Q3s

Directories

Path Synopsis
cmd
Package docs GENERATED BY SWAG; DO NOT EDIT This file was generated by swaggo/swag
Package docs GENERATED BY SWAG; DO NOT EDIT This file was generated by swaggo/swag
internal
pkg

Jump to

Keyboard shortcuts

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