GitHub - create-go-app/net_http-go-template: 📝 net/http backend template for Create Go App CLI. (original) (raw)

net/http backend template for Create Go App CLI

Package net provides a portable interface for network I/O, including TCP/IP, UDP, domain name resolution, and Unix domain sockets. Although the package provides access to low-level networking primitives.

Package net/http provides HTTP client and server implementations.

⚡️ 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:
   • 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
   • github.com/go-critic/go-critic for checking Go the best practice issues
   • github.com/golangci/golangci-lint for checking Go linter issues
3. Run project by this command:
4. Go to API Docs page (Swagger): 127.0.0.1:5000/swagger/index.html

📦 Used packages

🗄 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
• ./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/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/database folder with database setup functions (by default, PostgreSQL)
• ./platform/migrations folder with migration files (used with golang-migrate/migrate tool)

⚙️ Configuration

.env

Server settings:

SERVER_HOST="0.0.0.0" SERVER_PORT=5000 SERVER_READ_TIMEOUT=60

JWT settings:

JWT_SECRET_KEY="secret" JWT_REFRESH_KEY="refresh"

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

⚠️ License

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