Fiber backend template for Create Go App CLI and Modified

go version go report license

Fiber is an Express.js inspired web framework build on top of Fasthttp, the fastest HTTP engine for Go. Designed to ease things up for fast development with zero memory allocation and performance in mind.

⚡️ Quick start

  1. Create a new project with Fiber:

cgapp create

# Choose a backend framework:
#   net/http
# > fiber
#   chi
  1. Rename .env.example to .env and fill it with your environment values.

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

  3. Run project by this command:

make docker.run
  1. Go to API Docs page (Swagger): 127.0.0.1:5000/swagger/index.html

Screenshot

📦 Used packages

Name Version Type
gofiber/fiber v2.34.1 core
gofiber/jwt v2.2.7 middleware
arsmn/fiber-swagger v2.31.1 middleware
stretchr/testify v1.7.5 tests
golang-jwt/jwt v4.4.2 auth
spf13/viper v1.4.0 config
go-gorm/gorm v1.3.5 database
go-redis/redis v8.11.5 cache
swaggo/swag v1.8.3 utils
google/uuid v1.3.0 utils
go-playground/validator v10.10.0 utils
creasty/defaults v1.6.0 utils
uber-go/zap v1.21.0 logger

🗄 Template structure

./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

./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)

⚙️ Configuration

# Stage status to start server:
#   - "development", for start server without graceful shutdown
#   - "production", for start server with graceful shutdown
STAGE="dev"

# Server settings:
SERVER_HOST="0.0.0.0"
SERVER_PORT=5000
SERVER_READ_TIMEOUT=60s

# JWT settings:
JWT_SECRET_KEY="secret"
JWT_SECRET_KEY_EXPIRE=15m
JWT_REFRESH_KEY="refresh"
JWT_REFRESH_KEY_EXPIRE=720h

# Database settings:
DB_HOST="cgapp-postgres"
DB_PORT=5432
DB_USER="postgres"
DB_PASSWORD="password"
DB_NAME="postgres"
DB_SSL_MODE="disable"
DB_MAX_CONNECTIONS=100
DB_MAX_IDLE_CONNECTIONS=10
DB_MAX_LIFETIME_CONNECTIONS=2

# Redis settings:
REDIS_HOST="cgapp-redis"
REDIS_PORT=6379
REDIS_PASSWORD=""
REDIS_DB_NUMBER=0

⚠️ License

Apache 2.0 © Vic Shóstak & True web artisans.

GitHub

View Github