josegpt

README

josegpt.com

This is my personal space :)

Quick start

Development

go mod download
go run cmd/josegpt/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 -o josegpt cmd/josegpt/main.go
./josegpt

License

AGPL-3.0-or-later

Documentation

Index

• func IsLanguage(s string) bool
• func IsLicense(s string) bool
• type Language
  • func StringLanguage(s string) Language
  • func (l Language) String() string
• type License
  • func StringLicense(s string) License
  • func (l License) String() string
• type Project
• type ProjectFinder
• type ProjectRepository
• type ProjectService
• type ProjectUpsert
• type ProjectUpserter
• type TemplateRenderer
• type VCService

Functions

func IsLanguage

func IsLanguage(s string) bool

func IsLicense

func IsLicense(s string) bool

Types

type Language

type Language uint8

const (
	Unknown Language = iota
	C
	Go
	PHP
	Java
	Shell
	EmacsLisp
	JavaScript
)

func StringLanguage

func StringLanguage(s string) Language

func (Language) String

func (l Language) String() string

type License

type License uint8

const (
	None License = iota
	ISC
	MIT
	GPL3
	AGPL3
	LGPL3
)

func StringLicense

func StringLicense(s string) License

func (License) String

func (l License) String() string

type Project

type Project struct {
	Name        string
	Description string
	URL         string
	Topics      []string
	Fork        bool
	License     License
	Language    Language
}

type ProjectFinder

type ProjectFinder interface {
	Find(ctx context.Context, topic string) ([]*Project, error)
}

type ProjectRepository

type ProjectRepository interface {
	Projects(ctx context.Context, topic string) ([]*Project, error)
	UpsertProjects(ctx context.Context, pp []*ProjectUpsert) error
}

type ProjectService

type ProjectService interface {
	ProjectFinder
	ProjectUpserter
}

type ProjectUpsert

type ProjectUpsert struct {
	Name        string
	Description string
	URL         string
	Topics      []string
	Fork        bool
	License     License
	Language    Language
	CreatedAt   time.Time
	UpdatedAt   time.Time
}

type ProjectUpserter

type ProjectUpserter interface {
	Upsert(ctx context.Context, pp []*ProjectUpsert) error
}

type TemplateRenderer

type TemplateRenderer interface {
	Render(wr io.Writer, page template.Pager) error
}

type VCService

type VCService interface {
	Projects(ctx context.Context) ([]*ProjectUpsert, error)
}