{"id":23138639,"url":"https://github.com/skamranahmed/estimatex","last_synced_at":"2025-09-01T07:36:20.869Z","repository":{"id":265465024,"uuid":"890974617","full_name":"skamranahmed/estimatex","owner":"skamranahmed","description":"estimatex is a cli tool designed to facilitate story point estimation of tasks/tickets directly from the terminal.","archived":false,"fork":false,"pushed_at":"2024-11-29T13:59:28.000Z","size":1571,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-04T09:46:21.786Z","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-19T14:07:23.000Z","updated_at":"2025-02-17T01:29:40.000Z","dependencies_parsed_at":null,"dependency_job_id":"ac1dd465-eae8-4471-90d0-3bbe0447229a","html_url":"https://github.com/skamranahmed/estimatex","commit_stats":null,"previous_names":["skamranahmed/estimatex"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/skamranahmed/estimatex","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skamranahmed%2Festimatex","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skamranahmed%2Festimatex/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skamranahmed%2Festimatex/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skamranahmed%2Festimatex/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/skamranahmed","download_url":"https://codeload.github.com/skamranahmed/estimatex/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skamranahmed%2Festimatex/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273088878,"owners_count":25043587,"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-09-01T02:00:09.058Z","response_time":120,"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-17T13:11:25.944Z","updated_at":"2025-09-01T07:36:20.815Z","avatar_url":"https://github.com/skamranahmed.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"## 👨‍💻 EstimateX (`estimatex`)\n\n`estimatex` is a Command-Line Interface (CLI) tool designed to facilitate **story point estimation** of tasks/tickets directly from the terminal.\n\nThis client communicates with the [`estimatex-server`](https://github.com/skamranahmed/estimatex-server) via a **WebSocket connection**.\n\n#### 🚀 Demo\n\n##### Room Create Demo\n\u003cimg alt=\"Room Create Demo\" src=\"./room-create-demo.gif\" /\u003e\n\n##### Room Join Demo\n\u003cimg alt=\"Room join Demo\" src=\"./room-join-demo.gif\" /\u003e\n\n### 🙌 Why I Built This\nIn my team, story point estimation is an integral part of our sprint planning process. It's a collaborative effort that helps us gauge the complexity of tasks and plan our work effectively.\n\nWhile we often use open-source web based tools for this, I wondered if I could create a CLI-based tool for the same process.\n\nThat curiosity led me to build `estimatex`, a cli-based tool for story point estimation.\n\nThe motivation was to:\n\n- Explore WebSocket-based real-time communication.\n\n- Create a lightweight, terminal-first alternative for story point estimation sessions.\n\n### ✨ Features\n\n#### Room Management\n- **Create Estimation Rooms**: Create private rooms for estimation sessions with configurable maximum capacity\n- **Join Existing Rooms**: Join ongoing estimation sessions using room IDs\n- **Real-time Updates**: Get real-time updates in your terminal session when team members join the room\n\n#### Estimation Process\n- **Story Point Voting**: Choose from standard Fibonacci sequence values (1, 2, 3, 5, 8, 13, 21) for estimations\n- **Anonymous Voting**: Votes remain hidden until all team members have submitted their estimates\n- **Vote Revelation**: Room admin can trigger vote revelation once all members have voted\n- **Results Display**: Clear tabulated display of voting results showing:\n  - Distribution of votes\n  - Individual member votes\n  - Vote count per story point value\n\n#### User Experience\n- **Interactive CLI**: Simple command-line interface with clear prompts and emoji-enhanced feedback\n- **Secure WebSocket Communication**: Uses WSS (WebSocket Secure) protocol in production for secure real-time communication\n- **Graceful Exit**: Clean connection termination with CTRL+C, ensuring proper cleanup of WebSocket connections\n\n#### Administrative Controls\n- **Room Capacity Management**: Automatic handling of room capacity limits\n- **Session Control**: Room admin has control over when to start voting and reveal results\n- **Development Mode**: Built-in development mode for testing with local server setup\n\n### 🛠️ Installation \u0026 Usage\n\n#### Option 1: Download Binary (Recommended)\nPre-built binaries are available for Linux, macOS, and Windows. Download the latest release from the [releases page](https://github.com/skamranahmed/estimatex/releases).\n\n1. **For macOS/Linux:**\n   ```bash\n   # Download the appropriate tar.gz for your OS\n   tar xvf estimatex_\u003cOS\u003e_\u003cARCH\u003e.tar.gz\n\n   # Make the binary executable\n   chmod +x ./estimatex\n\n   # Move binary to a directory in your PATH\n   sudo mv estimatex /usr/local/bin/\n   ```\n\n2. **For Windows:**\n   - Download the `.zip` file for Windows\n   - Extract the archive\n   - Add the extracted directory to your PATH or run `estimatex.exe` directly\n\n#### Option 2: Run from Source\nIf you prefer to run from source, you'll need Go installed on your system.\n\n1. Clone the repository:\n   ```bash\n   git clone https://github.com/skamranahmed/estimatex.git\n   cd estimatex\n   ```\n\n2. Install dependencies:\n   ```bash\n   make dep\n   ```\n\n3. Run the application:\n   ```bash\n   make run\n   ```\n\n#### Development Mode\nBy default, the application runs in production mode connecting to the hosted server. To run in development mode:\n\n1. Set `isDevelopment = true` in `main.go`\n2. Ensure you have the [estimatex-server](https://github.com/skamranahmed/estimatex-server) running locally\n3. Run using `make run`\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","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fskamranahmed%2Festimatex","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskamranahmed%2Festimatex/lists"}