{"id":13427471,"url":"https://github.com/django-fluent/fluentcms-countdown","last_synced_at":"2025-03-18T04:26:54.034Z","repository":{"id":21724288,"uuid":"25045926","full_name":"django-fluent/fluentcms-countdown","owner":"django-fluent","description":"Countdown timer plugin for django-fluent CMS","archived":false,"fork":false,"pushed_at":"2021-11-16T14:38:42.000Z","size":75,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-04-15T00:20:04.879Z","etag":null,"topics":["countdown-timer","django-fluent"],"latest_commit_sha":null,"homepage":"http://django-fluent.org/","language":"Python","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/django-fluent.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGES.rst","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":"2014-10-10T17:32:00.000Z","updated_at":"2021-11-16T14:37:51.000Z","dependencies_parsed_at":"2022-08-17T16:25:21.337Z","dependency_job_id":null,"html_url":"https://github.com/django-fluent/fluentcms-countdown","commit_stats":null,"previous_names":["edoburu/fluentcms-countdown"],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/django-fluent%2Ffluentcms-countdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/django-fluent%2Ffluentcms-countdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/django-fluent%2Ffluentcms-countdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/django-fluent%2Ffluentcms-countdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/django-fluent","download_url":"https://codeload.github.com/django-fluent/fluentcms-countdown/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244155632,"owners_count":20407389,"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":["countdown-timer","django-fluent"],"created_at":"2024-07-31T01:00:28.836Z","updated_at":"2025-03-18T04:26:54.009Z","avatar_url":"https://github.com/django-fluent.png","language":"Python","funding_links":[],"categories":["Content Plugins"],"sub_categories":[],"readme":"fluentcms-countdown\n===================\n\n.. image:: https://github.com/django-fluent/fluentcms-countdown/actions/workflows/tests.yaml/badge.svg?branch=master\n    :target: https://github.com/django-fluent/fluentcms-countdown/actions/workflows/tests.yaml\n.. image:: https://img.shields.io/pypi/v/fluentcms-countdown.svg\n    :target: https://pypi.python.org/pypi/fluentcms-countdown/\n.. image:: https://img.shields.io/pypi/l/fluentcms-countdown.svg\n    :target: https://pypi.python.org/pypi/fluentcms-countdown/\n.. image:: https://img.shields.io/codecov/c/github/django-fluent/fluentcms-countdown/master.svg\n    :target: https://codecov.io/github/django-fluent/fluentcms-countdown?branch=master\n\n\nA plugin for django-fluent-contents_ to show a countdown timer on a website.\n\nIt's based on the jQuery plugin found at: http://keith-wood.name/countdown.html\n\nInstallation\n============\n\nFirst install the module, preferably in a virtual environment. It can be installed from PyPI::\n\n    pip install fluentcms-countdown\n\n\nBackend Configuration\n---------------------\n\nFirst make sure the project is configured for django-fluent-contents_.\n\nThen add the following settings::\n\n    INSTALLED_APPS += (\n        'fluentcms_countdown',\n    )\n\nThe database tables can be created afterwards::\n\n    ./manage.py syncdb\n\nNow, the ``CountDownPlugin`` can be added to your ``PlaceholderField``\nand ``PlaceholderEditorAdmin`` admin screens.\n\n\nFrontend Configuration\n----------------------\n\nMake sure that all plugin media files are exposed by django-fluent-contents_::\n\n    {% load fluent_contents_tags %}\n\n    {% render_content_items_media %}\n\nThis tag should be placed at the bottom of the page, after all plugins are rendered.\nFor more configuration options - e.g. integration with django-compressor -\nsee the `template tag documentation \u003chttps://django-fluent-contents.readthedocs.io/en/latest/templatetags.html#frontend-media\u003e`_.\n\nCSS Code\n~~~~~~~~\n\nThe stylesheet code is purposefully left out, since authors typically like to provide their own styling.\n\nTo get started quickly, include ``fluentcms_countdown/vendor/jquery.countdown.css`` in your site.\n\nJavaScript Code\n~~~~~~~~~~~~~~~\n\nNo configuration is required for the JavaScript integration,\n\nBy default, the plugin includes all required JavaScript code to run the timer.\n\nThe includes can be customized however, using the following settings::\n\n    JQUERY_PLUGIN_JS = 'fluentcms_countdown/vendor/jquery.plugin.min.js'\n\n    JQUERY_COUNTDOWN_JS = 'fluentcms_countdown/vendor/jquery.countdown.min.js'\n\n    JQUERY_COUNTDOWN_LOCALE_JS = 'fluentcms_countdown/vendor/jquery.countdown-{locale}.js'\n\n    COUNTDOWN_JS = 'fluentcms_countdown/countdown.js'\n\nFor example, if another plugin also uses ``jquery.plugin.js``, redefine the setting, so both plugins use the same file::\n\n    JQUERY_PLUGIN_JS = 'mysite/vendor/jquery.plugin.min.js'\n\nIf a value is defined as ``None``, it will be excluded from the frontend media.\n\nHTML code\n~~~~~~~~~\n\nIf needed, the HTML code can be overwritten by redefining ``fluentcms_countdown/countdown.html``.\nAny ``data-...`` attributes on the ``countdown`` element will be read by the JavaScript code;\nthis can be used to provide custom settings to the countdown init script.\n\nContributing\n------------\n\nIf you like this module, forked it, or would like to improve it, please let us know!\nPull requests are welcome too. :-)\n\n.. _django-fluent-contents: https://github.com/django-fluent/django-fluent-contents\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdjango-fluent%2Ffluentcms-countdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdjango-fluent%2Ffluentcms-countdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdjango-fluent%2Ffluentcms-countdown/lists"}