vc

README

vc

VC Service

Quick start

Development

go mod download
go run cmd/vc/main.go

Test

go test -v -cover ./...

Coverage Func

go test -coverprofile=c.out ./...
go tool cover -func c.out

Coverage HTML

go test -coverprofile=c.out ./...
go tool cover -html c.out

Deployment

go mod download
go build ./...
./vc

Documentation

Index

• Variables
• type Config
• type GRPC
• type Project
• type ProjectsRequest
• type ProjectsResponse
• type Service
• type Validate
  • func NewValidate(s Service) Validate
  • func (v Validate) Projects(r *ProjectsRequest) (*ProjectsResponse, error)

Variables

var (
	ErrUsernameRequired = errors.New("username must be provided")
)

Types

type Config

type Config struct {
	GRPC GRPC `toml:"grpc"`
}

type GRPC

type GRPC struct {
	Port int `toml:"port"`
}

type Project

type Project struct {
	Name        string   `json:"name"`
	Description *string  `json:"description,omitempty"`
	URL         string   `json:"html_url"`
	Topics      []string `json:"topics"`
	Fork        bool     `json:"fork"`
}

type ProjectsRequest

type ProjectsRequest struct {
	Username string
}

type ProjectsResponse

type ProjectsResponse struct {
	Projects []*Project
}

type Service

type Service interface {
	Projects(r *ProjectsRequest) (*ProjectsResponse, error)
}

type Validate

type Validate struct {
	// contains filtered or unexported fields
}

func NewValidate

func NewValidate(s Service) Validate

func (Validate) Projects

func (v Validate) Projects(r *ProjectsRequest) (*ProjectsResponse, error)