refactor: update repository structure (#173)

- move code to pkg to make it importable
- added badges to README
- fix go report spelling errors

Author: morremeyer

.goreleaser.yaml

@@ -6,7 +6,7 @@ builds:
       - windows
       - darwin
     ldflags:
-      - -X github.com/envelope-zero/backend/internal/controllers.version={{.Version}}
+      - -X github.com/envelope-zero/backend/pkg/controllers.version={{.Version}}
 archives:
   - replacements:
       darwin: Darwin

.pre-commit-config.yaml

@@ -27,11 +27,11 @@ repos:
         language: system
         pass_filenames: false
         entry: swag fmt
-        files: ^internal/.*
+        files: ^pkg/.*
 
       - id: swag init
         name: Create swagger docs.go
         language: system
         pass_filenames: false
-        entry: swag init --parseDependency --output ./swag
-        files: ^internal/.*
+        entry: swag init --parseDependency --output ./api
+        files: ^pkg/.*

.prettierignore

@@ -1 +1 @@
-swag/**
+api/**

Dockerfile

@@ -7,7 +7,7 @@ COPY go.mod go.sum ./
 RUN go mod download
 
 COPY internal ./internal
-COPY swag ./swag
+COPY api ./api
 COPY main.go Makefile ./
 
 ARG VERSION=0.0.0

Makefile

@@ -24,4 +24,4 @@ coverage: test
 VERSION ?= $(shell git rev-parse HEAD)
 .PHONY: build
 build:
-	go build -ldflags "-X github.com/envelope-zero/backend/internal/controllers.version=${VERSION}"
+	go build -ldflags "-X github.com/envelope-zero/backend/pkg/controllers.version=${VERSION}"

README.md

@@ -1,5 +1,7 @@
 # Envelope Zero backend
 
+[![Release](https://img.shields.io/github/release/envelope-zero/backend.svg?style=flat-square)](https://github.com/envelope-zero/backend/releases/latest) [![Go Reference](https://pkg.go.dev/badge/github.com/envelope-zero/backend.svg)](https://pkg.go.dev/github.com/envelope-zero/backend) [![Go Report Card](https://goreportcard.com/badge/github.com/envelope-zero/backend)](https://goreportcard.com/report/github.com/envelope-zero/backend)
+
 Envelope Zero is fundamentally rooted in two ideas:
 
 - Using the [envelope method](https://en.wikipedia.org/wiki/Envelope_system) to budget expenses into envelopes.

swag/docs.go renamed to api/docs.go

@@ -1,6 +1,6 @@
-// Package swag GENERATED BY SWAG; DO NOT EDIT
+// Package api GENERATED BY SWAG; DO NOT EDIT
 // This file was generated by swaggo/swag
-package swag
+package api
 
 import "github.com/swaggo/swag"
 
@@ -51,6 +51,7 @@ const docTemplate = `{
                 "tags": [
                     "General"
                 ],
+                "summary": "v1 API",
                 "responses": {
                     "200": {
                         "description": "OK",
@@ -1705,6 +1706,7 @@ const docTemplate = `{
                 "tags": [
                     "General"
                 ],
+                "summary": "API version",
                 "responses": {
                     "200": {
                         "description": "OK",

swag/swagger.json renamed to api/swagger.json

@@ -39,6 +39,7 @@
                 "tags": [
                     "General"
                 ],
+                "summary": "v1 API",
                 "responses": {
                     "200": {
                         "description": "OK",
@@ -1693,6 +1694,7 @@
                 "tags": [
                     "General"
                 ],
+                "summary": "API version",
                 "responses": {
                     "200": {
                         "description": "OK",

swag/swagger.yaml renamed to api/swagger.yaml

@@ -498,6 +498,7 @@ paths:
           description: OK
           schema:
             $ref: '#/definitions/controllers.V1Response'
+      summary: v1 API
       tags:
       - General
     options:
@@ -1613,6 +1614,7 @@ paths:
           description: OK
           schema:
             $ref: '#/definitions/controllers.VersionResponse'
+      summary: API version
       tags:
       - General
     options:

go.mod

@@ -73,6 +73,6 @@ require (
 	modernc.org/sqlite v1.17.1 // indirect
 )
 
-replace github.com/envelope-zero/backend/internal/controllers => ./internal/controllers
+replace github.com/envelope-zero/backend/pkg/controllers => ./pkg/controllers
 
-replace github.com/envelope-zero/backend/swag => ./swag
+replace github.com/envelope-zero/backend/api => ./api