ololx / birthday-cake

This is a simple animated birthday cake to congratulate someone.

birthday-cake

This is a simple animated birthday cake to congratulate someone.

📇 Table of Contents

• About
• Demo
• Features
• Getting Started
• Contributing
• Versioning
• Authors
• Licensing

📖 About

This is a simple animated birthday cake written in Vanilla JavaScript, CSS and HTML. It allows you to set the number of candles, the addressee name to display the phrase "Happy Birthday" or set your own congratulations. It is deployed here https://ololx.github.io/birthday-cake/.

📸 Demo

This animation demonstrate the usage process.

🎚 Features

• Click on the cake to put out all candles.
• Click on the candle to put it out.

To Do

• For more information on an upcoming development, please read the todo list. No plans.

Changelog

• For more information on a releases, a features and a changes, please read the changelog notes.

🚦 Getting Started

These instructions allow to get a copy of this project and run it on a local machine.

Installing

In order to install it is quite simple to clone or download this repository.

Cloning

For the cloning this repository to a local machine, just use the follows link:

https://github.com/ololx/birthday-cake

Using

To use it is enough to open the index.html file in the web-browser.

It's possible to define the count of candles and addresse name or set your own congratulations via request param.

• To specify the candles count use the param candles. For instance setup the 15 candles on the cake:

?candles=15

Live example here https://ololx.github.io/birthday-cake/?candles=15

• To specify the name in the congratulation message use the param name. For instance setup the Green as a name in the congratulation message :

?name=Green

Live example here https://ololx.github.io/birthday-cake/?name=Green

• To specify the congratulations message use the param message. For instance setup the greeting message:

?message=Happy%20Birthday,%20Green&message=Have%20a%20nice%20Day

Live example here https://ololx.github.io/birthday-cake/?message=Happy%20Birthday,%20Green&message=Have%20a%20nice%20Day

🗒 Versioning

For the versioning is used Semantic Versioning. For the versions available, see the changelog or the tags on this repository.

©️ Authors

• Alexander A. Kropotin - Initial work - ololx.

🔏 Licensing

This project is unlicensed - see the lisence document for details.