go-api-starter

command module
v0.0.0 Latest Latest
Warning

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

Go to latest
Published: Oct 11, 2024 License: GPL-3.0 Imports: 20 Imported by: 0

README

Golang API starter

Gopher flash

Development

Run the development server:

./run watch # or ./run docker-watch

Production

Build the project:

./run build

Run the production server:

./run start

Notes

  • The run script is used to automate common development/production tasks. Run ./run to see the available tasks.
  • The secrets should be stored in a secrets.json file in the root directory. If you want to use a different file, you can specify it using the SECRETS_FILE environment variable.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
Package docs Code generated by swaggo/swag.
Package docs Code generated by swaggo/swag.
internal
pkg
blobstore
Package blobstore provides a wrapper around S3 client.
Package blobstore provides a wrapper around S3 client.
cryptoutil
Package cryptoutil provides utility functions for encryption and decryption.
Package cryptoutil provides utility functions for encryption and decryption.
database
Package sqlite provides a wrapper around SQLite database.
Package sqlite provides a wrapper around SQLite database.
email
Package email provides utility functions for sending emails.
Package email provides utility functions for sending emails.
id
Package id provides utility functions for generating unique ids.
Package id provides utility functions for generating unique ids.
prettylog
Package prettylog provides a slog handler that pretty prints logs in JSON format for development purposes.
Package prettylog provides a slog handler that pretty prints logs in JSON format for development purposes.
repo
Package repo provides a wrapper around database.
Package repo provides a wrapper around database.

Jump to

Keyboard shortcuts

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