websockets

command module

v0.0.0-...-8626fa4 Latest Latest Go to latest Published: Jun 14, 2021 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

websockets for real-time communications with the frontend

go get -v github.com/cuttle-ai/websockets

Navigate into the project directory and run the following command

go run main.go

Enivironment Variable	Description
PORT	Port on to which application server listens to. Default value is 8080
RESPONSE_TIMEOUT	Timeout for the server to write response. Default value is 100ms
REQUEST_BODY_READ_TIMEOUT	Timeout for reading the request body send to the server. Default value is 20ms
RESPONSE_BODY_WRITE_TIMEOUT	Timeout for writing the response body. Default value is 20ms
PRODUCTION	Flag to denote whether the server is running in production. Default value is `false`
SKIP_VAULT	Skip loading the configurations from vault server. Default value is `false`.
IS_TEST	Denoting the run is test. This will load the test configuration from vault
MAX_REQUESTS	Maximum no. of concurrent requests supported by the server. Default value is 1000
REQUEST_CLEAN_UP_CHECK	Time interval after which error request app context cleanup has to be done. Default value is 2m

websockets websockets for real-time communications with the frontend

Path	Synopsis
config Package config will have necessary configuration for the application	Package config will have necessary configuration for the application
log Package log is used to print logs based of log types	Package log is used to print logs based of log types
routes Package routes has the routes supported by the api with proper versioning done Suppose a route is /list, it belonged to v2 and current version is v2.	Package routes has the routes supported by the api with proper versioning done Suppose a route is /list, it belonged to v2 and current version is v2.
response Package response handles utilities for writing error and normal responses to the response writer	Package response handles utilities for writing error and normal responses to the response writer
version Package version has the version information about the application	Package version has the version information about the application