go-micro-template

command module
v0.0.0-...-7501d5d Latest Latest
Warning

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

Go to latest
Published: Nov 30, 2024 License: MIT Imports: 1 Imported by: 0

README

Go Micro Template

This repository contains the source code for the Go Micro Template project.

Build, test, and deploy robust golang microservices

About the project

The template is used to create golang project. All golang projects must follow the conventions in the template. Calling for exceptions must be brought up in the engineering team.

Status

The template project is in beta status.

Reference

Getting started

Prerequisites
Setup
  1. Clone the repository and navigate to the root directory of the project:
git clone https://github.com/diki-haryadi/go-micro-template.git
cd go-micro-template
  1. Install the dependencies:
make dep
  1. Run the development server:
make run_dev

This will start the http server on port 4000 and grpc server on port 3000. You can customize the ports by setting the HTTP_PORT and GRPC_PORT environment variable.

Testing

To run the tests, use the following command:

make test

To generate a test coverage report, use the following command:

make test_coverage
Linting

To lint the code, use the following command:

make lint

This will run all available linters, including Go lint, Dockerfile lint, and YAML lint.

Building

To build the binary, use the following command:

make build

This will create a binary in the out/bin directory. You can run the binary with the following command:

make run
Cleaning

To clean the build artifacts and generated files, use the following command:

make clean

This will remove the bin and out directories, as well as any build-related files.

Continuous Integration

To run the continuous integration tasks, use the following command:

make ci

This will run the tests, linting, and code coverage tasks, and generate the corresponding reports. The reports will be saved to the out directory.

Notes

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

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