Feature/248 refactor project structure (#262)

Author: MaartendeKruijf

.github/workflows/ci.yml

@@ -60,7 +60,7 @@ jobs:
         run:  go install github.com/swaggo/swag/cmd/swag@latest  
         timeout-minutes: 12
       - name: Start docker containers for test
-        run: docker compose -f "docker/testing/httpbin-test/docker-compose.yml" up -d --build
+        run: docker compose -f "deployments/docker/testing/httpbin-test/docker-compose.yml" up -d --build
       - name: Run tests
         run: |
           sudo apt update

.github/workflows/release.yml

@@ -109,7 +109,6 @@ jobs:
         run: |
           go install github.com/swaggo/swag/cmd/swag@latest
           go install github.com/CycloneDX/cyclonedx-gomod/cmd/cyclonedx-gomod@latest
-          swag init -o swaggerdocs
           make sbom
           zip -r bin/sbom.zip bin
 

.gitignore

@@ -9,7 +9,7 @@ plugins/*
 build/*
 !build/build.md
 bin/*
-swaggerdocs/*
+api/*
 **.env
 test/cacao/flatfile-db-example.json
 

README.md

@@ -1,5 +1,5 @@
 <div align="center">
-<a href="https://cossas-project.org/cossas-software/soarca"><img src="img/soarca-logo.svg"/>
+<a href="https://cossas-project.org/cossas-software/soarca"><img src="assets/soarca-logo.svg"/>
 
 
 [![https://cossas-project.org/portfolio/SOARCA/](https://img.shields.io/badge/website-cossas--project.org-orange)](https://cossas-project.org/portfolio/SOARCA/)

img/kroki-settings.png assets/kroki-settings.pngimg/kroki-settings.png renamed to assets/kroki-settings.png

@@ -3,11 +3,11 @@ package main
 import (
 	"fmt"
 
+	api "soarca/api"
 	"soarca/internal/controller"
-	"soarca/logger"
-	"soarca/routes/status"
-	"soarca/swaggerdocs"
-	"soarca/utils"
+	"soarca/internal/logger"
+	"soarca/pkg/api/status"
+	"soarca/pkg/utils"
 
 	"github.com/joho/godotenv"
 )
@@ -36,25 +36,25 @@ const banner = `
 
 `
 
-//	@title		SOARCA API
-//	@version	1.0.0
+// @title		SOARCA API
+// @version	1.0.0
 func main() {
 	fmt.Print(banner)
 	log.Info("Version: ", Version)
 	log.Info("Buildtime: ", Buildtime)
 
-	errenv := godotenv.Load(".env")
-	if errenv != nil {
+	err := godotenv.Load(".env")
+	if err != nil {
 		log.Warning("Failed to read env variable, but will continue")
 	}
 	Host = "localhost:" + utils.GetEnv("PORT", "8080")
-	swaggerdocs.SwaggerInfo.Host = Host
+	api.SwaggerInfo.Host = Host
 
 	// Version is only available here
 	status.SetVersion(Version)
-	errinit := controller.Initialize()
-	if errinit != nil {
-		log.Fatal("Something Went wrong with setting-up the app, msg: ", errinit)
-		panic(errinit)
+	err = controller.Initialize()
+	if err != nil {
+		log.Fatal("Something Went wrong with setting-up the app, msg: ", err)
+		panic(err)
 	}
 }