net/http backend template¶

• Create a new project with Fiber:

cgapp create

# Choose a backend framework:
# > net/http
#   Fiber

• Rename .env.example to .env and fill it with your environment values.

• Install Docker and the following useful Go tools to your system:

  • golang-migrate/migrate for apply migrations
  • github.com/swaggo/swag for auto-generating Swagger API docs
  • github.com/securego/gosec for checking Go security issues

• Run project by this command:

make docker.run

• Go to API Docs page (Swagger): 127.0.0.1:5000/swagger/index.html.

./app

Folder with business logic only. This directory doesn't care about what database driver you're using or which caching solution your choose or any third-party things.

• ./app/controllers folder for functional controllers (used in routes)
• ./app/models folder for describe business models and methods of your project
• ./app/queries folder for describe queries for models of your project
• ./app/validators folder for describe validators for models fields

./docs

Folder with API Documentation. This directory contains config files for auto-generated API Docs by Swagger.

./pkg

Folder with project-specific functionality. This directory contains all the project-specific code tailored only for your business use case, like configs, middleware, routes or utils.

• ./pkg/configs folder for configuration functions
• ./pkg/middleware folder for add middleware (Fiber built-in and yours)
• ./pkg/repository folder for describe const of your project
• ./pkg/routes folder for describe routes of your project
• ./pkg/utils folder with utility functions (server starter, error checker, etc)

./platform

Folder with platform-level logic. This directory contains all the platform-level logic that will build up the actual project, like setting up the database or cache server instance and storing migrations.

• ./platform/cache folder with in-memory cache setup functions (by default, Redis)
• ./platform/database folder with database setup functions (by default, PostgreSQL)
• ./platform/migrations folder with migration files (used with golang-migrate/migrate tool)