{"id":39584760,"url":"https://github.com/devmatteini/football-calendar","last_synced_at":"2026-01-26T15:01:21.773Z","repository":{"id":199574355,"uuid":"685241205","full_name":"devmatteini/football-calendar","owner":"devmatteini","description":"Automatically sync your google calendar with football matches of your favorite team!","archived":false,"fork":false,"pushed_at":"2026-01-17T12:01:54.000Z","size":750,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-17T22:56:25.653Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/devmatteini.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-08-30T20:05:17.000Z","updated_at":"2026-01-17T12:01:58.000Z","dependencies_parsed_at":"2026-01-17T14:04:23.217Z","dependency_job_id":null,"html_url":"https://github.com/devmatteini/football-calendar","commit_stats":null,"previous_names":["devmatteini/football-calendar"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/devmatteini/football-calendar","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devmatteini%2Ffootball-calendar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devmatteini%2Ffootball-calendar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devmatteini%2Ffootball-calendar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devmatteini%2Ffootball-calendar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devmatteini","download_url":"https://codeload.github.com/devmatteini/football-calendar/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devmatteini%2Ffootball-calendar/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28781308,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-26T13:55:28.044Z","status":"ssl_error","status_checked_at":"2026-01-26T13:55:26.068Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":[],"created_at":"2026-01-18T07:35:27.100Z","updated_at":"2026-01-26T15:01:21.767Z","avatar_url":"https://github.com/devmatteini.png","language":"TypeScript","funding_links":[],"categories":["\u003ca name=\"TypeScript\"\u003e\u003c/a\u003eTypeScript"],"sub_categories":[],"readme":"# Football Calendar\n\n[![CI](https://github.com/devmatteini/football-calendar/actions/workflows/main.yml/badge.svg)](https://github.com/devmatteini/football-calendar/actions/workflows/main.yml)\n\nAutomatically sync your google calendar with football matches of your favorite team!\n\nTable of content:\n\n-   [Installation](#installation)\n-   [Setup](#setup)\n    -   [Api-Football](#api-football)\n    -   [Google Calendar](#google-calendar)\n-   [Build executable](#build)\n-   [Usage](#usage)\n-   [License](#license)\n\n## Installation\n\n```bash\ngit clone --depth=1 https://github.com/devmatteini/football-calendar.git\ncd football-calendar\npnpm install\n```\n\n## Setup\n\n### Api-Football\n\n1. Create a new account with api-football (RapidAPI is not supported): https://dashboard.api-football.com/register\n2. Find API key in `Account -\u003e My Access`\n3. You can find football teams ids at this page: https://dashboard.api-football.com/soccer/ids/teams\n\n### Google calendar\n\n#### Google Console Project\n\n1. Create a new google cloud project: https://console.cloud.google.com\n2. Enable calendar api: API \u0026 Services -\u003e Library -\u003e Search \"google calendar api\" -\u003e open it and click Enable\n3. Create api credentials: API \u0026 Services -\u003e Google Calendar API -\u003e open `Credentials` tab -\u003e Click `Create Credentials` -\u003e Choose `Service account` -\u003e Enter `football-calendar` as name -\u003e Done\n4. Inside the service account page -\u003e open Keys tab -\u003e Add keys -\u003e Create new key -\u003e JSON -\u003e Create\n\n#### Google Calendar\n\n1. Go to https://calendar.google.com/ and login with the same google account that you created the console project\n2. Open Settings -\u003e Add calendar -\u003e choose `Create new calendar`\n\n    **NOTE: make sure to set GMT/UTC as time zone (from my tests with other time zones it may cause issues)**\n\n3. Open the newly created calendar -\u003e Share with specific people or groups -\u003e Add people or groups -\u003e Insert the service account email (you can find this in the service account list or detail page) and `Make changes to events` as permissions\n4. If you want reminders, open the newly created calendar settings -\u003e Event notifications -\u003e Add notification (for some reasons Google Calendar API is not able to set reminders on non-primary calendars).\n\n## Build\n\nBuild and then move the executable to a directory in your `$PATH`\n\n```bash\npnpm build\nmv dist/football-calendar ~/.local/bin\nfootball-calendar --help\n```\n\n## Usage\n\nIf you haven't already done so, follow the [setup](#setup) process.\n\n### Export environment variables\n\n```bash\nexport API_FOOTBALL_TOKEN=\"...\"\n\n# This is the file that was downloaded after creating the service account credentials\nexport GOOGLE_CALENDAR_KEY_FILE=\"/path/to/calendar/keys.json\"\n\n# Google Calendar -\u003e Settings -\u003e Open your `calendar` -\u003e Integrate calendar -\u003e Copy Calendar ID\nexport GOOGLE_CALENDAR_ID=\"...\"\n```\n\n### Create configuration file\n\nThese are the default paths where the configuration file is searched:\n\n-   `$XDG_CONFIG_HOME/football-calendar/config.json`\n-   `$HOME/.config/football-calendar/config.json`\n\nYou can change the default path with `export FOOTBALL_CALENDAR_CONFIG=/path/to/file.json` environment variable.\n\nSearch your teams/leagues at these pages:\n\n-   https://dashboard.api-football.com/soccer/ids/teams\n-   https://dashboard.api-football.com/soccer/ids\n\nYou can start from an example running `football-calendar config example`, or you can get the JSON Schema with\n`football-calendar config schema`\n\n```json5\n[\n  {\n    \"_tag\": \"Team\",\n    \"teamId\": 529,\n    \"name\": \"Barcelona\"  // This is just to easily identify the team\n  },\n  {\n    \"_tag\": \"League\",\n    \"leagueId\": 4, // Select League id v3\n    \"name\": \"Euro Championship\",\n    \"season\": 2024,\n    \"round\": \"KnockoutStage\" // possible options: All, KnockoutStage, Final \n  }\n]\n\n```\n\n### Run the application\n\n```bash\nfootball-calendar sync\n```\n\n### Logging\n\nExport environment variable `LOG_LEVEL` to change the minimum log level.\nThe possible values are:\n\n-   `Debug`\n-   `Info` (default)\n-   `Error`\n\n## License\n\n`football-calendar` is made available under the terms of the MIT License.\n\nSee the [LICENSE](LICENSE) file for license details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevmatteini%2Ffootball-calendar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevmatteini%2Ffootball-calendar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevmatteini%2Ffootball-calendar/lists"}