Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/theflyingcodr/sockets
[WIP] Go library for building a socket server and client, featuring middleware support, channels, handler funcs and re-connects.
https://github.com/theflyingcodr/sockets
channels client go golang rooms server sockets socketserver
Last synced: 8 days ago
JSON representation
[WIP] Go library for building a socket server and client, featuring middleware support, channels, handler funcs and re-connects.
- Host: GitHub
- URL: https://github.com/theflyingcodr/sockets
- Owner: theflyingcodr
- License: mit
- Created: 2021-10-15T16:38:48.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-07-17T10:48:47.000Z (over 1 year ago)
- Last Synced: 2023-07-27T22:43:06.083Z (over 1 year ago)
- Topics: channels, client, go, golang, rooms, server, sockets, socketserver
- Language: Go
- Homepage:
- Size: 13.7 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# sockets
> Channel based socket library on top of gorilla/sockets giving listeners, middleware, server and clients.
[](https://github.com/theflyingcodr/sockets/releases)
[](https://github.com/theflyingcodr/sockets/actions/workflows/go.yml)
[](https://github.com/theflyingcodr/sockets/actions/workflows/codeql-analysis.yml)
[](https://goreportcard.com/report/github.com/theflyingcodr/sockets)
[](https://codecov.io/gh/theflyingcodr/sockets)
[](https://golang.org/)
## Table of Contents
- [Installation](#installation)
- [Documentation](#documentation)
- [Examples & Tests](#examples--tests)
- [Usage](#usage)
- [Maintainers](#maintainers)
- [Contributing](#contributing)
- [License](#license)
## Installation
**sockets** requires a [supported release of Go](https://golang.org/doc/devel/release.html#policy).
```shell script
go get -u github.com/theflyingcodr/sockets
```
## Documentation
View the generated [documentation](https://pkg.go.dev/github.com/theflyingcodr/sockets)
[](https://pkg.go.dev/github.com/theflyingcodr/sockets)
For more information around the technical aspects of Bitcoin, please see the updated [Bitcoin Wiki](https://wiki.bitcoinsv.io/index.php/Main_Page)
### Features
- Client / Server implementations
- Middleware
- Error handlers
- Listener funcs
- Channel based messaging
- Client reconnects
- Broadcasting directly from server to client or to entire channel
Library Deployment
[goreleaser](https://github.com/goreleaser/goreleaser) for easy binary or library deployment to Github and can be installed via: `brew install goreleaser`.
The [.goreleaser.yml](.goreleaser.yml) file is used to configure [goreleaser](https://github.com/goreleaser/goreleaser).
Use `make release-snap` to create a snapshot version of the release, and finally `make release` to ship to production.
## Examples & Tests
All unit tests and [examples](examples) run via [Github Actions](https://github.com/theflyingcodr/sockets/actions) and
uses [Go version 1.17.x](https://golang.org/doc/go1.17). View the [configuration file](.github/workflows/go.yml).
Run all tests
```shell script
make pre-commit
```
## Usage
View the [examples](examples)
## Maintainers
| [
](https://github.com/theflyingcodr)
|:---:|
| [MS](https://github.com/theflyingcodr)|
## Contributing
View the [contributing guidelines](CONTRIBUTING.md) and please follow the [code of conduct](CODE_OF_CONDUCT.md).
### How can I help?
All kinds of contributions are welcome :raised_hands:!
The most basic way to show your support is to star :star2: the project, or to raise issues :speech_balloon:.
You can also support this project by [becoming a sponsor on GitHub](https://github.com/sponsors/theflyingcodr) :clap:
## License
