{"id":19964082,"url":"https://github.com/pilotpirxie/scrum-tool-api","last_synced_at":"2026-05-08T14:02:48.135Z","repository":{"id":59423876,"uuid":"490003940","full_name":"pilotpirxie/scrum-tool-api","owner":"pilotpirxie","description":"🧑‍💻 Websocket api for for scrum master toolkit written in Typescript \u0026 Node","archived":false,"fork":false,"pushed_at":"2022-12-21T01:46:22.000Z","size":83248,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-14T23:03:54.840Z","etag":null,"topics":["api","api-server","node","pm2","server","socket","socket-io","ts","ts-node","typescript","websocket","websocket-server","websockets","ws","wss"],"latest_commit_sha":null,"homepage":"https://scrumpurr.eu","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pilotpirxie.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-05-08T16:59:34.000Z","updated_at":"2023-03-04T05:04:32.000Z","dependencies_parsed_at":"2023-01-30T02:30:59.365Z","dependency_job_id":null,"html_url":"https://github.com/pilotpirxie/scrum-tool-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/pilotpirxie/scrum-tool-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pilotpirxie%2Fscrum-tool-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pilotpirxie%2Fscrum-tool-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pilotpirxie%2Fscrum-tool-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pilotpirxie%2Fscrum-tool-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pilotpirxie","download_url":"https://codeload.github.com/pilotpirxie/scrum-tool-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pilotpirxie%2Fscrum-tool-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279001871,"owners_count":26083197,"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-10-09T02:00:07.460Z","response_time":59,"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":["api","api-server","node","pm2","server","socket","socket-io","ts","ts-node","typescript","websocket","websocket-server","websockets","ws","wss"],"created_at":"2024-11-13T02:19:15.210Z","updated_at":"2025-10-09T17:35:50.509Z","avatar_url":"https://github.com/pilotpirxie.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# scrum-tool-api\nSimple tool for scrum ceremonies. Perfect for retrospective and planning meetings. \nWritten in TypeScript, using WebSockets, Node and React.\n\n[Link to the repository with client](https://github.com/pilotpirxie/scrum-tool-client)\n\n### Features\n* Quick and easy to use\n* No registration required\n* Responsive design\n* Open source, funny avatars\n* Use websocket or http polling as fallback\n\n### Getting started\nInstall Nginx.\n```shell\nsudo apt update\nsudo apt install nginx\nsudo ufw allow 'Nginx HTTP'\nsudo ufw enable\nsudo ufw status\nsystemctl status nginx\n```\n\nConfigure reverse proxy to point to the application.\n```shell\n# /etc/nginx/sites-available/default\nserver {\n     listen [::]:80;\n     listen 80;\n\n     server_name yourdomainname.com;\n\n     location / {\n         proxy_pass http://localhost:3001;\n         proxy_http_version 1.1;\n         proxy_set_header Upgrade $http_upgrade;\n         proxy_set_header Connection 'upgrade';\n         proxy_set_header Host $host;\n         proxy_cache_bypass $http_upgrade;\n    }\n}\n```\n\nCheck if configuration is ok and reload.\n```shell\nsudo nginx -t\nsudo service nginx restart\n```\n\nInstall Node and essentials required for some dependencies.\n```shell\ncurl -sL https://deb.nodesource.com/setup_16.x | sudo -E bash -\nsudo apt install -y nodejs\n\nnode -v\nnpm -v\n\nsudo apt install build-essential\n```\n\nIf you are using API with postgres only (if you stick to default sqlite3, you can skip this) install postgres, create new database and setup user.\n```shell\nsudo apt install postgresql postgresql-contrib\nsudo systemctl start postgresql.service\nsudo -u postgres createuser --interactive\nsudo -u postgres createdb scrumdb\nsudo -u postgres psql\nALTER USER postgres PASSWORD 'mysecretpassword';\n```\n\nInstall certbot and configure SSL.\n```shell\nsudo apt install python3-certbot-nginx\nsudo ufw allow 'Nginx Full'\nsudo ufw delete allow 'Nginx HTTP'\nsudo certbot --nginx -d yourdomainname.com\n```\n\nInstall PM2 and start the application.\n```shell\nnpm install yarn pm2 -g\n\n# in project directory\nyarn\npm2 install typescript\npm2 start app.ts\n\n# OR without process manager\nyarn prod\n```\n\n### License\n```\nMIT\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpilotpirxie%2Fscrum-tool-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpilotpirxie%2Fscrum-tool-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpilotpirxie%2Fscrum-tool-api/lists"}