go-api-reference

module
v0.0.0-...-ed7ba4f Latest Latest
Warning

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

Go to latest
Published: Sep 7, 2024 License: MIT

README

Go REST API Reference Project

Installation

Install https://github.com/golang-migrate/migrate/tree/v4.17.1/cmd/migrate for DB migrations.

Usage

Make sure a MySql database is running with a database named ecom then run the migrations.

make migrate-up

Run the project:

make run

Reference the Makefile for more commands.

Tests

Run the tests:

make test

Directories

Path Synopsis
cmd
Package main : Application entry point
Package main : Application entry point
api
Package api : API server
Package api : API server
migrate
Package main : Database migration
Package main : Database migration
Package config : Configuration package
Package config : Configuration package
Package db : Database package
Package db : Database package
service
auth
Package auth : Authentication package
Package auth : Authentication package
cart
Package cart : Cart service
Package cart : Cart service
order
Package order : Order service
Package order : Order service
product
Package product : Product service
Package product : Product service
user
Package user : User service
Package user : User service
Package types contains the types used in the application.
Package types contains the types used in the application.
Package validator : Validator package
Package validator : Validator package

Jump to

Keyboard shortcuts

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