Ukraine Banners is a tool used to create banners for your website to show support for Ukraine. This repository holds the JS and CSS for the banners, if you want to use these banners inside your Laravel application, please visit the Laravel Ukraine Banners repository.

⚡️ Quickstart

Include the already compiled JavaScript into your website and initialize the banner.

<script src="https://ukraine.wavey.group/banner.min.js"></script>
<script type="text/javascript">
UKRAINE.init(["dark", "small", "bottom-right"]);
UKRAINE.createBanner();
</script>

📖 Usage

Firstly, clone the repository and install the dependencies.

git clone https://github.com/waveygroup/ukraine-banners.git && cd ukraine-banners && npm install

Now lets compile the JavaScript and CSS.

npm run build

This will compile the JavaScript and CSS into the dist folder. You can now include the JavaScript and CSS into your website.

You can also watch for changes and automatically compile the JavaScript and CSS.

npm run watch

👍 Contribute

If you want to say thank you and/or support the active development of Ukraine Banners:

1. Add a GitHub Star to the project.
2. Tweet about the project on your twitter.
3. Write a review or tutorial on Medium, Dev.to or personal blog.
4. Support the project by pleding through GitHub. All donations will be donated to the Ukrainian Red Cross.

🛡️ Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

⚠️ License

Copyright (c) 2022-present Wavey Group and Contributors. Ukraine Banners is free and open-source software licensed under the MIT License.