{"id":23505301,"url":"https://github.com/skamranahmed/estimatex-server","last_synced_at":"2025-08-04T05:35:21.905Z","repository":{"id":269255473,"uuid":"892233342","full_name":"skamranahmed/estimatex-server","owner":"skamranahmed","description":"estimatex-server is the backend component for estimatex, enabling real-time story point estimation through WebSocket communication.","archived":false,"fork":false,"pushed_at":"2024-11-29T13:19:38.000Z","size":37,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-08T22:59:59.696Z","etag":null,"topics":["golang","planning-poker","realtime-communication","websocket"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/skamranahmed.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-21T18:31:07.000Z","updated_at":"2025-02-17T01:29:08.000Z","dependencies_parsed_at":"2024-12-22T07:27:37.506Z","dependency_job_id":"30e86180-abd6-4ede-8ca4-6960d52a8417","html_url":"https://github.com/skamranahmed/estimatex-server","commit_stats":null,"previous_names":["skamranahmed/estimatex-server"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/skamranahmed/estimatex-server","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skamranahmed%2Festimatex-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skamranahmed%2Festimatex-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skamranahmed%2Festimatex-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skamranahmed%2Festimatex-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/skamranahmed","download_url":"https://codeload.github.com/skamranahmed/estimatex-server/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skamranahmed%2Festimatex-server/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268654906,"owners_count":24285124,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-04T02:00:09.867Z","response_time":79,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["golang","planning-poker","realtime-communication","websocket"],"created_at":"2024-12-25T09:30:49.747Z","updated_at":"2025-08-04T05:35:21.852Z","avatar_url":"https://github.com/skamranahmed.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"## 👨‍💻 EstimateX Server (`estimatex-server`)\n\n`estimatex-server` is the backend component for [`estimatex`](https://github.com/skamranahmed/estimatex), enabling real-time story point estimation through WebSocket communication. This server handles room management, user connections, and message broadcasting to facilitate collaborative estimation sessions.\n\n### ✨ Features\n- Real-time WebSocket communication\n- Room-based collaboration with admin controls\n- Support for multiple concurrent estimation sessions\n- Automatic room cleanup on admin disconnect\n- Configurable room capacity\n- Structured event system for client-server communication\n\n### ❓ How It Works\n1. Clients connect to the server using WebSocket.\n2. The server facilitates communication by:\n   - Handling room creation and joining\n   - Receiving client events (e.g., room actions, votes), validating them, and executing the appropriate logic\n   - Broadcasting events, votes and results in real-time\n   - Managing session state (e.g., participants, room data)\n3. Outputs final session results upon completion\n\n### 🙌 Getting Started\n\n#### Prerequisites\n- Go 1.x or higher\n- Make (optional, for using Makefile commands)\n\n#### Installation\n1. Clone the repository:\n   ```bash\n   git clone https://github.com/skamranahmed/estimatex-server.git\n   cd estimatex-server\n   ```\n\n2. Install dependencies:\n   ```bash\n   make dep\n   # or\n   go mod tidy \u0026\u0026 go mod download\n   ```\n\n#### Running the Server\n```bash\nmake run\n# or\ngo run main.go\n```\nThe server will start on port `8080`\n\n### 🚀 API Reference\n\n#### WebSocket Endpoint\n- URL Path: `/ws`\n- Protocol: `ws://` or `wss://`\n\n#### Query Parameters\n- `action`: Either `CREATE_ROOM` or `JOIN_ROOM`. It is a required parameter.\n- `name`: Client's display name. It is a required parameter.\n- `max_room_capacity`: Maximum number of participants. It is a required parameter when `action` is `CREATE_ROOM`. \n- `room_id`: ID of the room to join. It is a required parameter when `action` is `JOIN_ROOM`.\n\n#### Events\nThe server implements a bidirectional event system:\n\n##### Incoming Events\n- `JOIN_ROOM`: When a client joins a room\n- `BEGIN_VOTING`: Admin initiates voting\n- `MEMBER_VOTED`: Member submits their vote\n- `REVEAL_VOTES`: Admin reveals all votes\n\n##### Outgoing Events\n- `ROOM_JOIN_UPDATES`: Room membership updates\n- `ROOM_CAPACITY_REACHED`: Room is full\n- `BEGIN_VOTING_PROMPT`: Prompt for admin to start voting\n- `ASK_FOR_VOTE`: Request for members to vote\n- `VOTING_COMPLETED`: All votes received\n- `REVEAL_VOTES_PROMPT`: Prompt for admin to reveal votes\n- `VOTES_REVEALED`: Final vote results\n- `AWAITING_ADMIN_VOTE_START`: Waiting for admin to start next vote\n\n##### Incoming + Outgoing Events\n- `CREATE_ROOM`: Room creation event\n\n### 🧠 Project Structure\n```\n.\n├── cmd/\n│   └── app.go          # Server setup and configuration\n├── internal/\n│   ├── api/            # API response handling\n│   ├── controller/     # WebSocket connection management\n│   ├── entity/         # Domain models\n│   ├── event/          # Event definitions\n│   └── session/        # Session management\n├── main.go             # Application entry point\n├── Makefile            # Build and run commands\n└── README.md           # Documentation\n```\n\n#### Available Make Commands\n- `make dep`: Install dependencies\n- `make run`: Start the server\n\n### 📝 License\nThis project is licensed under the [MIT License](https://choosealicense.com/licenses/mit/)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskamranahmed%2Festimatex-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fskamranahmed%2Festimatex-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskamranahmed%2Festimatex-server/lists"}