docs

package
v0.0.0-...-d323686 Latest Latest
Warning

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

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

README

extra chatbot framework

Setup

install dev tools
./docs/install.sh

extra json config

See extra.conf

Dev tools


# Generator cli
go run github.com/flowline-io/flowbot/cmd/composer generator bot -name example -rule input,group,agent,command,condition,cron,form
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

Lint

# install
go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest

# check
golangci-lint run --timeout=10m --config=./.golangci.yaml ./...

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

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{},
	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