https://github.com/paulorohling/live-cursors
Live Cursors is a sample web application that allows you to share your cursors with others.
https://github.com/paulorohling/live-cursors
angular collaborative golang live-cursor websocket
Last synced: about 1 month ago
JSON representation
Live Cursors is a sample web application that allows you to share your cursors with others.
- Host: GitHub
- URL: https://github.com/paulorohling/live-cursors
- Owner: pauloRohling
- License: mit
- Created: 2024-09-19T01:30:04.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-01T16:56:13.000Z (over 1 year ago)
- Last Synced: 2025-03-01T17:33:57.912Z (over 1 year ago)
- Topics: angular, collaborative, golang, live-cursor, websocket
- Language: Go
- Homepage:
- Size: 236 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Live Cursors
Live Cursors is a sample web application that allows you to share your cursors with others.
This project was created as an experiment about how to use WebSockets to implement a real-time cursor sharing application. The application uses [Gorilla WebSocket](https://github.com/gorilla/websocket) to send and receive cursor positions in real-time.
## Prerequisites
- [Go](https://go.dev/doc/install)
- [Docker](https://docs.docker.com/get-docker/)
- [API Ninjas Account](https://api-ninjas.com/)
- [Node.js](https://nodejs.org/en/download/)
- [Air](https://github.com/air-verse/air)
- [Gorilla WebSocket](https://github.com/gorilla/websocket)
## Environment Variables
| Variable | Description | Default Value | Required |
|--------------------------|---------------------------------------------|------------------------------------------|----------|
| `SERVER_PORT` | Port to listen on | 8080 | false |
| `API_URL` | URL of the API | https://api.api-ninjas.com/v1/randomuser | false |
| `API_KEY` | API key for the API | - | true |
| `HTTP_MAX_RETRY` | Maximum number of retries for HTTP requests | 3 | false |
| `HTTP_MAX_RETRY_TIMEOUT` | Maximum timeout for HTTP requests | 5s | false |
| `HTTP_MIN_RETRY_TIMEOUT` | Minimum timeout for HTTP requests | 1s | false |
## License
Live Cursors is released under the MIT License. See the [LICENSE](LICENSE) file for more information.