Project Structure

Here you will learn about folder structure

Folder Name

Remarks

app

Includes project bootstrapping functions

assets

Includes all essential non-go files required for the project

config

Includes configs and related settings for different services

migrations

Includes the models that requires to be stored as database object

pkg

Includes all main logic of the project

pkg/auth

Includes functions related to Authentication and Authorization

pkg/models

Includes all database representing go files and their related functions

pkg/services

Includes business logic using those models

public

Includes files required for Frontend to load

resources

Includes non-go files required for representing Frontend

resources/src

Includes non-go files for VueJS Frontend and other related CSS and Js files

resources/views

Includes non-go html templates

rest

Includes controllers, middlewares and routes required by the project to run

rest/controllers

Includes all handlers for each API Endpoint defined in rest/routes

rest/middlewares

Includes middlewares that check and filter the request to be sent to handlers

rest/routes

Includes API Endpoint defined for the project interface with end users

storage

Includes any non-go intermediate generated files

storage/logs

Includes log files

uploads

Includes any files uploaded by any user

utils

Include reusable utilities

Last updated