Fiber backend template¶
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.
- Create a new project with Fiber:
cgapp create # Choose a backend framework: # net/http # > Fiber
.envand fill it with your environment values.
Install Docker and the following useful Go tools to your system:
Run project by this command:
- Go to API Docs page (Swagger): 127.0.0.1:5000/swagger/index.html.
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/controllersfolder for functional controllers (used in routes)
./app/modelsfolder for describe business models and methods of your project
./app/queriesfolder for describe queries for models of your project
./app/validatorsfolder for describe validators for models fields
Folder with API Documentation. This directory contains config files for auto-generated API Docs by Swagger.
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/configsfolder for configuration functions
./pkg/middlewarefolder for add middleware (Fiber built-in and yours)
./pkg/repositoryfolder for describe
constof your project
./pkg/routesfolder for describe routes of your project
./pkg/utilsfolder with utility functions (server starter, error checker, etc)
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/cachefolder with in-memory cache setup functions (by default, Redis)
./platform/databasefolder with database setup functions (by default, PostgreSQL)
./platform/migrationsfolder with migration files (used with golang-migrate/migrate tool)
# .env # Stage status to start server: # - "dev", for start server without graceful shutdown # - "prod", for start server with graceful shutdown STAGE_STATUS="dev" # Server settings: SERVER_HOST="0.0.0.0" SERVER_PORT=5000 SERVER_READ_TIMEOUT=60 # JWT settings: JWT_SECRET_KEY="secret" JWT_SECRET_KEY_EXPIRE_MINUTES_COUNT=15 JWT_REFRESH_KEY="refresh" JWT_REFRESH_KEY_EXPIRE_HOURS_COUNT=720 # Database settings: DB_HOST="localhost" 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="localhost" REDIS_PORT=6379 REDIS_PASSWORD="" REDIS_DB_NUMBER=0