Giter Site home page Giter Site logo

easy-countdown's Introduction

Client CI

gif

Easy countdown

Easy countdown is an easy to setup countdown page. Can be setup as a countdown or as a timer

Setup

Using docker (Recommended)

If you use docker, just edit the docker-compose.yml file so that it fits your needs

Variables Definition Example
TIMER_BACKGROUND The url of an image that will be used for as background https://wallpaperplay.com/walls/full/0/7/6/29912.jpg
TIMER_TARGET The target date of the countdown, if date is in the future, timer will decrease, otherwise it will increase Fri Oct 01 2021 15:33:36 GMT+0200
TIMER_TITLE The title of the countdown, can be empty My title!

Example of docker-compose.yml file

This example is a copy-paste of docker-compose.production.yml in the repo

version: "3.8"

services:
  web:
    stdin_open: true # So that the serving is not exited with code 0
    image: yooooomi/easy-countdown
    environment:
      TIMER_BACKGROUND: https://wallpaperplay.com/walls/full/0/7/6/29912.jpg
      TIMER_TARGET: "Fri Oct 01 2021 15:33:36 GMT+0200" # Get help with https://esqsoft.com/javascript_examples/date-to-epoch.htm
      TIMER_TITLE: "My next birthday" # Can be empty
    ports:
      - "3000:3000"

Without docker

This method builds the project following the env variables you gave, producing a build folder that has to be served manually afterwards. You can use serve to achieve it

Use yarn to use the build script from the package.json. Simply use yarn build. Use the variables above in the env to personalize your countdown

  • npm install
  • TIMER_TITLE="example" yarn build

Variables will be taken from env, and are the same as above

I.E: TIMER_TARGET="Fri Oct 01 2021 15:33:36 GMT+0200" yarn build && serve -s -l tcp://0.0.0.0:3000 build/

easy-countdown's People

Contributors

yooooomi avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

easy-countdown's Issues

Image source?

Do I have to pull the image from another webserver? Could I maybe use a docker bind mount or docker volume to reference a local file within the docker container?

Help with editing the text and countdown of the file

Looking for help in making this a little easier to use. I would love to adjust the text color and location. Can this be easily edited? I found it in some of the CSS files, but I have no idea how to then implement them into my docker image.

Thanks!

issue setting up TIMER_TARGET

Fri Aug 30 2024 09:00:00 GMT-0400

I am having issue setting up the above countdown

Image works
Custom text work

Everytime I refresh it showed a different remaining time And counter is not going down every second like the gif posted

I used the url provided to step the time but still not luck

I also tried the default date and changed year to 2024 still no luck

I am using unraid and made my own container

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.