brook

wpff-backend

brook project for starting your backend service. Built with Go

Menu

• Features
• Install
• Quick Start
• Detailed Guide
• APIs
• Roadmap
• FAQ
• Contributing
• Contributors

Features

This brook also include this library.

• Database: sqlx or gorm
• Log: zap or zerolog
• Tracing: opentracing
• Metrics: prometheus
• Mocking: mock
• Migrate: goose
• Router: chi
• Grpc: grpc-go

Observability Tools

This Observability tools

• grafana
• jaeger

Prerequisite

• Golang 1.16.x or later
• Docker

Install

...coming soon

Quick Start

Create Development Environment

Create dev env means we run docker-compose. You can adjust services with your project stack. (eg. add elasticsearch, redis, etc)

First time only :

  make start-dev
  make migrate-up
  make seed

Every time you develop :

  make start-dev

  make check-dev

Unit Testing

to do simple test simply run

make unit-test

to do test using sonarqube please read this https://github.com/kevintanuhardi/mvs_api/-/wikis/How-to-do-testing-using-Sonarqube-on-local-environment-(Linux)

Migrate data to development database

Make sure the development environment is ready, then

  make migrate-up

Seed initial data

  make seed

Stop Development Environment

  make stop-dev

Runing Service

REST

1. Local

  make rest

2. Docker

For docker please make sure, mysql dsn in .brook.yml. Change port to 3306 and address to db.

make docker-rest

Detailed Guide

...coming soon

APIs

...coming soon

FAQ

...coming soon

Roadmap

• Phase 1: Init
• Phase 2: Deployment & Development Standarization
• Phase 3: Release Train improvements
• Phase 4: DX improvements
• Phase 5: Stabilize
• Phase 6: Road to Open Source [TBD]

Contributing

Feel like contributing? That's awesome! We have a contributing guide to help guide you.