{"id":25629551,"url":"https://github.com/Devenet/AdventCalendar","last_synced_at":"2026-06-10T12:30:17.909Z","repository":{"id":12139926,"uuid":"14732653","full_name":"Devenet/AdventCalendar","owner":"Devenet","description":"Light PHP application to show a picture and its legend per day before Christmas or an event.","archived":false,"fork":false,"pushed_at":"2023-11-30T22:09:37.000Z","size":3442,"stargazers_count":20,"open_issues_count":2,"forks_count":15,"subscribers_count":3,"default_branch":"master","last_synced_at":"2023-12-01T12:29:13.398Z","etag":null,"topics":["adventcalendar","calendar","christmas","countdown","php"],"latest_commit_sha":null,"homepage":"https://devenet.eu/advent","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Devenet.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":"2013-11-26T23:50:04.000Z","updated_at":"2023-12-01T10:17:30.000Z","dependencies_parsed_at":"2022-09-12T11:22:44.849Z","dependency_job_id":null,"html_url":"https://github.com/Devenet/AdventCalendar","commit_stats":null,"previous_names":[],"tags_count":12,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Devenet%2FAdventCalendar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Devenet%2FAdventCalendar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Devenet%2FAdventCalendar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Devenet%2FAdventCalendar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Devenet","download_url":"https://codeload.github.com/Devenet/AdventCalendar/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240222473,"owners_count":19767463,"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":["adventcalendar","calendar","christmas","countdown","php"],"created_at":"2025-02-22T19:17:25.970Z","updated_at":"2026-06-10T12:30:15.826Z","avatar_url":"https://github.com/Devenet.png","language":"PHP","funding_links":[],"categories":["PHP"],"sub_categories":[],"readme":"# AdventCalendar\n\nAdvent Calendar is a light web application to show a picture and its legend per day before Christmas, or any other event.  \nIt’s written in PHP with modern web technologies.\n\n→ [See a demo](https://www.devenet.eu/advent/demo).\n\n\n![Home of Advent Calendar](adventcalendar.jpg)\n\n***\n\n## You are in a hurry?\n\nOK, let's do it quickly!\n\n```\ngit clone https://github.com/Devenet/AdventCalendar advent\ncd advent/private\ncp settings.example.json settings.json\n```\n\nThen edit the `settings.json` file to configure the application and set the year — or [generate settings file](https://www.devenet.eu/advent/generator/#settings) and put it in the `private` folder.\n\nTo finish, just put your image files in the `private` folder; images named with the number of the day (such as `1.jpeg`, `2.jpg`, `3.png`).  \nSupported formats are: JPG/JPEG, PNG, GIF.\n\n**NEW** You can now use a video file with MP4 format.  \nThe video will be served by the PHP app, so I strongly recommand that you only use a lightweight video file.\n\n***\n\n## Installation\n\n### Get the source\n\nDownload the last version on the [releases page](https://github.com/Devenet/AdventCalendar/releases).\n\n### Or clone the repository\n\nIf you have git on your server, you can also just clone the repository with:\n\n```\ngit clone https://github.com/Devenet/AdventCalendar advent\n```\n\n## Configuration\n\n### Basic configuration\n\nCopy the `settings.example.json` file on folder `private` to `settings.json` and edit it to configure the application.\n\nThe minimum required configuration file must contains:\n```json\n{\n  \"title\": \"Advent Calendar · 2023\",\n  \"year\": 2023\n}\n```\n\n### Transform AdventCalendar into CountDownCalendar\n\nIf you want, you can also customize month, first day and last day which are used to display the period of days, but it's not really an AdventCalendar anymore ;-)\n\nJust change the period with those 3 options:\n```json\n{\n  \"month\": 3,\n  \"first_day\": 8,\n  \"last_day\": 31\n}\n```\nIt will make a countdown calendar for March from the 8th to the 31th.\n\n### Full available options\n\n_Feel free to use the online [settings file generator](https://www.devenet.eu/advent/generator/#settings) to easily build your `settings.json` file, and then put it into the `private` folder._\n\n| Property | Type | Description |\n| --- | --- | --- |\n| __`title`__ | string | __Required__ Set the title of your AdventCalendar. |\n| __`year`__ | integer | __Required__ Set the year to be used for the calendar and the cutdown. |\n| __`month`__ | integer | Specific month to turn on a countdown calendar. Default is 12. |\n| __`first_day`__ | integer | Specific first day to turn on a countdown calendar. Default is 1. |\n| __`last_day`__ | integer | Specific last day to turn on a countdown calendar. Default is 24. |\n| __`lang`__ | string | Supported languages are `en` (default), `fr`, `de`. |\n| __`background`__ | string | Set to `alternate` to use the alternative background, otherwise set the URL of your custom background image. |\n| __`passkey`__ | string | If filled out, visitors need to enter a password to access the private AdventCalendar. |\n| __`disqus_shortname`__ | string | Set a Disqus account to enable comments for day pages. |\n| __`google_analytics`__ | object | Set a Google Analytics account with a child object containing the two properties `tracking_id` and `domain`. |\n| __`piwik`__ | object | Set a Piwik account with a child object containing the two properties `piwik_url` and `site_id`. |\n| __`plausible`__ | object | Set a Plausible account with a child object containing the property `domain` for _data-domain_. |\n| __`copyright`__ | string | Set a copyright notice; not displayed if empty (default). |\n| __`url_rewriting`__ | boolean | Set to `true` to enable rewriting URL and uncomment lines in the root `.htaccess` file. Default is `false`. |\n\n\nThis is an example with all options:\n```json\n{\n  \"title\": \"Advent Calendar · 2023\",\n  \"year\": 2023,\n  \"month\": 12,\n  \"first_day\": 1,\n  \"last_day\": 24,\n  \"lang\": \"en\",\n  \"background\": \"alternate\",\n  \"passkey\": \"My top secret password!\",\n  \"disqus_shortname\": \"myDisqusName\",\n  \"google_analytics\": {\n    \"tracking_id\": \"UC-12345\",\n    \"domain\": \"domain.tld\"\n  },\n  \"piwik\": {\n    \"piwik_url\": \"piwik.domain.tld\",\n    \"site_id\": \"12345\"\n  },\n  \"plausible\": {\n    \"domain\": \"domain.tld\"\n  },\n  \"copyright\": \"All content is under Creative Commons BY-NC 3.0 licence.\",\n  \"url_rewriting\": false\n}\n```\n\n## Picture per days\n\n### Add pictures\n\nPut your photos in the `private` folder, and name them with the number of the day you want to illustrate.\nFor example, for the 1st December, call your file `1.jpg` or `1.jpeg`.  \n\nSupported formats are: JPG/JPEG, PNG, GIF for images, and MP4 for videos.\n\n__Be sure that the access to `private` folder is forbidden when browsing it!__   \nFor Apache configuration, be sure that a `.htaccess` file with the directive `Require all denied` is in.\n\n### Customize legend and title\n\n_Feel free to use the online [calendar file generator](https://web.devenet.eu/advent/generator/#calendar) to easily build your `calendar.json` file, and then put it into the `private` folder._\n\nTo add a title, a legend or a text on a day page, just rename `calendar.example.json` in folder `private` in `calendar.json` and add what you want to display.\n\nFor example:\n\n```json\n{\n  \"6\": {\n    \"title\": \"Saint Nicholas Day\",\n    \"legend\": \"Berlin, March 2013\",\n    \"text\": \"Lorem ipsum dolor sit amet, […].\"\n  }\n}\n```\n\n#### Add a link\n\nIf you want that the image and legend point to a link, add the property `link` to the `calendar.json`:\n\n```json\n{\n  \"8\": {\n    \"legend\": \"Screnshot of Advent Calendar\",\n    \"link\": \"https://www.devenet.eu/advent\"\n  }\n}\n```\n\n![A day with title, legend and text](adventcalendar-day.jpg)\n\n***\n\n## Oups, problems?\n\n- __All days are shown before Christmas:__ Check the syntax in `settings.json` or update the year.\n- __Photo is not displayed:__ Be sure your photo is correctly named, like `3.jpg` or `12.jpeg` with the supported formats.\n- __Title, legend or text are not displayed:__ Check the syntax of your `calendar.json` file.\n- __Day is shown in late or advance:__ Configure the timezone of your server.\n\n\n## Want to contribute?\n\nSource code is developed by [Nicolas Devenet](https://nicolas.devenet.info) and hosted on [GitHub](https://github.com/Devenet/AdventCalendar). Feel free to fork it and to improve the application!\n\nLet me know if you use Advent Calendar by sending me an e-mail, I will be happy ;-)\n\n—\n\n❤️ Special thanks to  \n- [@fscholdei](https://github.com/fscholdei) for the German translation\n- [@Thaoh](https://github.com/Thaoh) for the Norwegian translation and the URL custom background feature\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDevenet%2FAdventCalendar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FDevenet%2FAdventCalendar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDevenet%2FAdventCalendar/lists"}