docs

package
v0.18.9 Latest Latest
Warning

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

Go to latest
Published: Nov 19, 2024 License: GPL-3.0 Imports: 1 Imported by: 0

README

extra chatbot framework

extra json config

See extra.conf

Dev tools

task

# install
go install github.com/go-task/task/v3/cmd/task@latest

# scripts
task -a

# Generator cli
go run github.com/flowline-io/flowbot/cmd/composer generator bot -name example -rule collect,command,cron,form,input,instruct
go run github.com/flowline-io/flowbot/cmd/composer generator vendor -name example

# Migrate cli
go run github.com/flowline-io/flowbot/cmd/composer migrate import

# Migration file cli
go run github.com/flowline-io/flowbot/cmd/composer migrate migration -name file_name

# workflow import yaml
go run github.com/flowline-io/flowbot/cmd/composer workflow import -token xxx -path ./docs/examples/docker_example.yaml

Lint

# install
go install github.com/mgechev/revive@latest

# check
revive -formatter friendly ./...

cloc

# install
sudo apt install cloc

# count
cloc --exclude-dir=node_modules --exclude-ext=json .

security

go install golang.org/x/vuln/cmd/govulncheck@latest

# check
govulncheck ./...

swagger

https://github.com/swaggo/swag/blob/master/README.md

# install
go install github.com/swaggo/swag/cmd/swag@latest

# generate
swag init -g cmd/main.go

# format
swag fmt -g cmd/main.go

migrate

# install
go install -tags 'postgres' github.com/golang-migrate/migrate/v4/cmd/migrate@latest

# migrate
migrate -source file://./internal/store/migrate  -database mysql://user:password@tcp(127.0.0.1:3306)/db?parseTime=True&collation=utf8mb4_unicode_ci up

gitleaks

# install
go install github.com/zricethezav/gitleaks/v8@v8.21.1

# check
gitleaks git -v

Documentation

Overview

Package docs Code generated by swaggo/swag. DO NOT EDIT

Index

Constants

This section is empty.

Variables

View Source
var SwaggerInfo = &swag.Spec{
	Version:          "1.0",
	Host:             "localhost:6060",
	BasePath:         "/service",
	Schemes:          []string{"http"},
	Title:            "Flowbot API",
	Description:      "Flowbot Chatbot API",
	InfoInstanceName: "swagger",
	SwaggerTemplate:  docTemplate,
	LeftDelim:        "{{",
	RightDelim:       "}}",
}

SwaggerInfo holds exported Swagger Info so clients can modify it

Functions

This section is empty.

Types

This section is empty.

Jump to

Keyboard shortcuts

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