https://github.com/onmax/ws-channels-go
Websocket server in golang
https://github.com/onmax/ws-channels-go
channels golang websocket
Last synced: about 1 year ago
JSON representation
Websocket server in golang
- Host: GitHub
- URL: https://github.com/onmax/ws-channels-go
- Owner: onmax
- License: mit
- Created: 2019-08-11T22:40:41.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-08-11T22:56:17.000Z (almost 7 years ago)
- Last Synced: 2025-03-23T22:21:30.366Z (about 1 year ago)
- Topics: channels, golang, websocket
- Language: Go
- Size: 18.6 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Channels using WebSockets in Go
This project is a backend websocket server. When a client connects to the system, the client could create his own channel or join other channel. The channels in the documentation and in the code are referred to rooms. One member only is in one room at the time. For further documentation, go to: [here](https://onmax.github.io/ws-channels-go/)
The purpose of this project, is to allow me to have a websocket server for further projects that I will make using Flutter.
## Run the application
You can use the ```Makefile``` and run ```make help``` to see all the options. To run the application using Docker, run:
```make docker-run```
It will create an image and run a container with the application serving on port 8080. You can change the port in the file ```.env```
Otherwise, you can run the application if you have golang in your machine using ```go run``` or ```go build```.
## Documentation
You can see the documentation [here](https://onmax.github.io/ws-channels-go/)
## Example
You can go to /example to see an implementation of a websocket client in JS. You will need to run the application in localhost.