{"id":26550979,"url":"https://github.com/savaged/golf-comp","last_synced_at":"2026-05-18T00:05:05.677Z","repository":{"id":283087981,"uuid":"950644355","full_name":"savaged/golf-comp","owner":"savaged","description":"low cost simple golf competition scoring system","archived":false,"fork":false,"pushed_at":"2025-03-25T14:07:11.000Z","size":142,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-25T14:40:27.762Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/savaged.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-03-18T13:29:33.000Z","updated_at":"2025-03-25T14:07:15.000Z","dependencies_parsed_at":"2025-03-18T14:33:49.619Z","dependency_job_id":"6cf11c7a-d591-45cf-90b3-5cbe1715b277","html_url":"https://github.com/savaged/golf-comp","commit_stats":null,"previous_names":["savaged/golf-comp"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/savaged/golf-comp","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/savaged%2Fgolf-comp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/savaged%2Fgolf-comp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/savaged%2Fgolf-comp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/savaged%2Fgolf-comp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/savaged","download_url":"https://codeload.github.com/savaged/golf-comp/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/savaged%2Fgolf-comp/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266270381,"owners_count":23902731,"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","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":[],"created_at":"2025-03-22T07:43:33.186Z","updated_at":"2026-05-18T00:04:55.664Z","avatar_url":"https://github.com/savaged.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# golf-comp\n\nA low-cost rudimentary golf competition scoring system using SMS with ClickSend and website hosting with Netlify.\n\n## Prerequisites\n\n* A Unix like command line.\n* The latest [npm](https://en.wikipedia.org/wiki/Npm) installed (usually from your standard package manager, e.g. apt).\n* The latest [csvkit](https://csvkit.readthedocs.io/en/latest/) for [csvsql](https://csvkit.readthedocs.io/en/latest/scripts/csvsql.html) installed.\n* The latest [netlify-cli](https://docs.netlify.com/cli/get-started/) installed.\n* Internet access and a browser.\n* Willingness to run shell scripts whilst others are enjoying competition.\n* Resilience if things go wrong.\n\n\n## Before a competition\n\n### Days prior\n\n* Setup a ClickSend account [here](https://clicksend.com).\n* Setup a Netlify account [here](https://netlify.com).\n* Gather the player data into a file named `players.csv` in the `data` folder (see the README in that folder).\n* Generate the ClickSend credentials with the shell script within the `src` folder.\n* Obtain a Netlify personal access token for use in shell scripts.\n* Setup the Netlify token for deployment by creating a file named `.netlify_env` with the contents `NETLIFY_AUTH_TOKEN=\"YOUR_NETLIFY_AUTH_TOKEN\"` and run `chmod 600 .netlify_env`.\n* Test by sending a SMS to yourself via a ClickSend campaign then replying with '1 4 2' and again with '2 5 1'.\n* Manually run the leaderboard generation and deployment from within your local repository for this project: `src/generate-leaderboard.sh`.\n* Check the output on your Netlify site.\n* Fix any issues.\n\n### A few days prior\n\n* Test by requesting a few highly cooperative players to send an SMS to the ClickSend number with three whole numbers separated by a single space, a few times with differing numbers.\n* Setup a cron job, that runs the deployment every 15 minutes for the competition day, by following these steps at the command line...\n    * `crontab -e`\n    * Add the following line (change the path to the file to suit you):\n        `*/15 8-19 * * * cd ~/repos/golf-comp \u0026\u0026 ~/repos/golf-comp/src/generate-leaderboard.sh 2\u003e\u00261 \u0026\u0026 ~/repos/golf-comp/src/deploy-leaderboard.sh 2\u003e\u00261`\n* Send an email with content based on the file `instructions-email.txt` in the `comms` folder.\n* Send a SMS via a ClickSend campaign with content based on the file `instructions-sms.txt` in the `comms` folder.\n\n### Just prior\n\n* Instruct players to use scorecards and return them at the end of their round as the primary and official way of inclusion in the competition.\n* Instruct players to send an SMS to the ClickSend number with the following content for each hole played: hole gross-score stableford-points (e.g. 1 4 2).\n* Instruct players to visit your Netlify site to see the leaderboard; refreshing their browser to see updates.\n\n\n## Roadmap\n\n* TODO Find a way to fully automate for realtime updates, initiated each time a player sends their SMS score.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsavaged%2Fgolf-comp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsavaged%2Fgolf-comp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsavaged%2Fgolf-comp/lists"}