fiber-boilerplate

module
v1.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 28, 2022 License: MIT

README

Fiber Boilerplate

Go Reference

Simple and scalable boilerplate to build powerful and organized REST projects with Fiber.

Directory Structure

├── app
│   ├── database
│   │   ├── schema
│   │   │   └── article.go
│   │   └── seeder
│   │       └── article_seeder.go
│   ├── middleware
│   │   ├── register.go
│   │   └── token
│   │       └── token.go
│   ├── module
│   │   └── article
│   │       ├── article_module.go
│   │       ├── controller
│   │       │   ├── article_controller.go
│   │       │   ├── article_controller_mock.go
│   │       │   └── controller.go
│   │       ├── repository
│   │       │   ├── article_repository.go
│   │       │   └── article_repository_mock.go
│   │       ├── request
│   │       │   └── article_request.go
│   │       └── service
│   │           ├── article_service.go
│   │           └── article_service_mock.go
│   └── router
│       └── api.go
├── build
│   ├── Dockerfile
│   └── DockerfileAir
├── cmd
│   └── example
│       ├── generate.go
│       └── main.go
├── config
│   └── example.toml
├── docker-compose.yaml
├── go.mod
├── go.sum
├── internal
│   └── bootstrap
│       ├── database
│       │   └── database.go
│       ├── logger.go
│       └── webserver.go
├── LICENSE
├── Makefile
├── README.md
├── storage
│   ├── ascii_art.txt
│   ├── private
│   │   └── example.html
│   ├── private.go
│   └── public
│       └── example.txt
└── utils
    ├── config
    │   └── config.go
    ├── response
    │   ├── response.go
    │   └── validator.go
    └── utils.go

Usage

You can run that commands to run project:

go mod download

go run cmd/example/main.go or air -c .air.toml if you want to use air

Docker
docker-compose build
docker-compose up

CUSTOM="Air" docker-compose up # Use with Air

Tech Stack

To-Do List

  • More error-free logging.
  • Add makefile to make something shorter.
  • Introduce repository pattern.
  • Add unit tests.
  • Add mocking with GoMock.

License

fiber-boilerplate is licensed under the terms of the MIT License (see LICENSE).

Directories

Path Synopsis
app
module/article/controller
Package mock_controller is a generated GoMock package.
Package mock_controller is a generated GoMock package.
module/article/repository
Package mock_repository is a generated GoMock package.
Package mock_repository is a generated GoMock package.
module/article/service
Package mock_service is a generated GoMock package.
Package mock_service is a generated GoMock package.
cmd
internal
ent

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL