Skip to content

kitabisa/buroq

Repository files navigation

Go Report Card technology:go Maintainability CircleCI

buroq

this is a bootstrap service build with GO for our cookie cutter.

just build it and run. localhost:[port]/health_check will give you HTTP status 200.

DB driver

Cache driver

Migration

Before you do the migration, please specify what DB that you want to migrate in configuration file with key is_migration_enable.

  • using sql-migrate
  • command: migrate for migrate up
  • command: migratedown for migrate down
  • command: migratenew [migration name] for create migration file

Seeding (Work in progress)

  • seeds for starter can be put on migrations/seeds/{number}.{table-name}.sql

Router

  • using go-chi
  • why? simplicity and easy to read

Metric (Work in progress)

GraphQL

  • you can see some docs about graphql integration with buroq under internal/app/graphql

Others

  • using perkakas for any our standard middlewares and for writing response
  • overall using the golang layout, with minor changes for own needs

IMPORTANT

  • whenever you start new service, please make the documentation using open api specification and put it on folder /api

Author