Skip to content

README.md

Latest commit

 

History

History
58 lines (37 loc) · 1.18 KB

README.md

File metadata and controls

58 lines (37 loc) · 1.18 KB
Raw

api5back

Install Go

  • Linux (Ubuntu / Mint)
sudo apt install golang-go
  • Linux (Arch / Garuda)
sudo pacman -S go

Install Air (recommended)

Air is a tool that provides a live reload server for Go applications, updating the running server when the source code changes, similar to nodemon for Node.js.

go install github.com/air-verse/air@latest

Install Swag

Swag is a tool that generates API documentation from Go source code.

go install github.com/swaggo/swag/cmd/swag@latest

Setup Husky

Husky is a tool that provides a simple way to manage the project's Git hooks.

The hooks are used to ensure code style consistency, run tests, and semantic commit messages.

Install Husky

This will setup the husky command globally.

go install github.com/automation-co/husky@latest

Activate the hooks

This will copy the hooks to the .git/hooks directory from the .husky/hooks directory.

husky install