{"id":16288960,"url":"https://github.com/rozsival/oribot","last_synced_at":"2025-04-09T08:45:06.091Z","repository":{"id":113633163,"uuid":"533782119","full_name":"rozsival/oribot","owner":"rozsival","description":"📊 Where's your worklog?","archived":false,"fork":false,"pushed_at":"2024-08-21T08:28:58.000Z","size":1593,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-15T03:13:54.283Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/rozsival.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":"2022-09-07T13:38:50.000Z","updated_at":"2024-08-21T08:29:02.000Z","dependencies_parsed_at":null,"dependency_job_id":"78090d28-a25f-4569-89d6-ed0dec831cfc","html_url":"https://github.com/rozsival/oribot","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rozsival%2Foribot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rozsival%2Foribot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rozsival%2Foribot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rozsival%2Foribot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rozsival","download_url":"https://codeload.github.com/rozsival/oribot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248008597,"owners_count":21032554,"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":"2024-10-10T19:49:48.519Z","updated_at":"2025-04-09T08:45:06.075Z","avatar_url":"https://github.com/rozsival.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n\u003ca href=\"https://github.com/ApiTreeCZ\"\u003e\n\u003cimg alt=\"ApiTree s.r.o.\" src=\"https://www.apitree.cz/static/images/logo-header.svg\" width=\"120\" /\u003e\n\u003cbr\u003e\nApiTree\n\u003c/a\u003e\n\u003c/p\u003e\n\u003ch1 align=\"center\"\u003eOriBot\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\nSimple \u003ca href=\"https://api.slack.com/apps/A0422H11QKS\"\u003eSlack bot\u003c/a\u003e to annoy Oriflame teammates with regular worklog agenda.\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\u003cimg alt=\"Where's your worklog?\" src=\"./public/wheres-your-worklog.gif\"\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://github.com/rozsival/oribot/actions/workflows/qa.yml\"\u003e\u003cimg alt=\"QA\" src=\"https://github.com/rozsival/oribot/actions/workflows/qa.yml/badge.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/rozsival/oribot/actions/workflows/codeql.yml\"\u003e\u003cimg alt=\"CodeQL\" src=\"https://github.com/rozsival/oribot/actions/workflows/codeql.yml/badge.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/rozsival/oribot/actions/workflows/deploy.yml\"\u003e\u003cimg alt=\"Deploy\" src=\"https://github.com/rozsival/oribot/actions/workflows/deploy.yml/badge.svg\"\u003e\u003c/a\u003e\n\n\u003chr\u003e\n\n## 💾 Installation\n\n```bash\nnvm use\nyarn install\n```\n\n## 🚀 Deployment\n\nThis app is deployed to [Google Cloud Run](https://console.cloud.google.com/run/detail/europe-central2/oribot/)\nvia [Deploy action](.github/workflows/deploy.yml) on push to `main` branch.\n\nAfter each deployment two parallel processes are started with `yarn start`:\n\n- app (`yarn start:app`) – bot worker that runs messaging schedule every day at specified time\n- server (`yarn start:server`) – [public web](https://oribot-vpnvbwijja-lm.a.run.app) just for the funsies\n\nTo save as many resources as possible, the Cloud Run instance auto-scales to 0 and idles when inactive. For this reason,\na [Cloud Scheduler job](https://console.cloud.google.com/cloudscheduler/jobs/edit/europe-central2/wakeup-oribot?project=apitree-oribot)\nis created to wake OriBot up every day at 9:55 AM (Europe/Prague).\n\n\u003e 🧠 Do not forget to update the schedule based on the configuration below.\n\n## ⚙️ Configuration\n\nThe app uses `.env` config which is based on `.env.example`:\n\n- `CHANNEL_ID` – Slack channel ID for messaging\n- `ClOSURE_DAY` – day of month on which the worklog agenda closes (defaults to `25`)\n- `DEBUG` – set `1` to disable sending messages and only output to console (defaults to `0`)\n- `DEBUG_DATE` – when `DEBUG=1` use this to simulate a specific date for test run (defaults to `undefined`)\n- `JOB_HOUR` – hour at which the messaging schedule runs daily (defaults to `10`)\n- `JOB_MONTH_END` – month in which the messaging schedule ends (defaults to `11`)\n- `JOB_MONTH_START` – month in which the messaging schedule starts (defaults to `2`)\n- `PORT` – port on which the public web is served (defaults to `8080`)\n- `TOKEN` – Slack [OAuth token](https://api.slack.com/apps/A0422H11QKS/oauth?) for ApiTree workspace\n- `TZ` – timezone to be used for dates and times (defaults to `Europe/Prague`)\n\n\u003e ⚠️ Values for `CHANNEL_ID` and `TOKEN` are mandatory and stored in\n\u003e the [Secret Manager](https://console.cloud.google.com/security/secret-manager?project=apitree-oribot).\n\n\u003e ℹ️ Right click on channel name in Slack and use `View channel details` to find channel ID.\n\n\u003e 🎄 By default, December and January are skipped in schedule due to end-of-year specific closure.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frozsival%2Foribot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frozsival%2Foribot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frozsival%2Foribot/lists"}