fiber-versioning-boilerplate

KO | EN

gitlite — search

#react #typescript #llm #golang #android #machine-learning #rust #linux #docker #macos #nodejs #java #awesome-list #open-source

fiber-versioning-boilerplate

(★ 28)

A boilerplate for fiber versioning, Clean Architecture, API versioning, API documentation, Data versioning

fiber-versioning-boilerplate Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Fiber Versioning Boilerplate
[![Linter](https://github.com/aofdev/fiber-versioning-boilerplate/workflows/Lint/badge.svg)](https://github.com/aofdev/fiber-versioning-boilerplate/actions)
[![Testing](https://github.com/aofdev/fiber-versioning-boilerplate/workflows/Testing/badge.svg)](https://github.com/aofdev/fiber-versioning-boilerplate/actions)

## Prerequisite

Make sure you have the following installed outside the current project directory and available in your `GOPATH`

- [golang](https://golang.org) 1.17+
- [docker](https://www.docker.com/get-started)
- [air](https://github.com/cosmtrek/air) for hot reloading
- [swagger](https://github.com/swaggo/swag) for automatically generate RESTful API

### Features ✨ 
- API Versioning
- Data Versioning
- Dynamic Struct Type
- Clean Architecture
- Postman Collections
- API Documentation with swagger

### Project structure 📁
```
api
  ├── adapters
  │  └── mongo.go
  ├── app.go
  ├── handlers
  │  ├── errors.go
  │  ├── parser_body.go
  │  └── response.go
  ├── utilities
  │  ├── configuration.go
  │  └── converter.go
  └── versions
    ├── v1
    │  ├── entities
    │  ├── factories
    │  ├── repositories
    │  ├── routes
    │  └── usecases
    └── v2
        ├── entities
        ├── factories
        ├── repositories
        ├── routes
        └── usecases
```

## Development environment setup

```sh
make setup
```

## Start the application ⚡️

```sh
make start
```
## Testing 🧪

```sh
make test
```

## Manual 🗒️

Run `make help` to list available commands:

```text
Choose a command run in fiber-versioning-boilerplate:

setup           Initialize project
  docker-start    Start docker-compose
  docker-stop     Stop docker-compose
  start           Start the application
  copy-env        Copy environment file
  gendoc          Generate docs api with swagger
  test            Run tests coverage
  mongo-dump      Dump MongoDB data for testing
  mongo-restore   Restore MongoDB data for testing

```

fiber-versioning-boilerplate

fiber-versioning-boilerplate Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

fiber-versioning-boilerplate

fiber-versioning-boilerplate Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README