An open API service indexing awesome lists of open source software.

https://github.com/waveygroup/ukraine-banners

πŸ‡ΊπŸ‡¦ Show your support for Ukraine with some simple website banners.
https://github.com/waveygroup/ukraine-banners

banner banners css html javascript nowar standwithukraine ukraine website

Last synced: 8 days ago
JSON representation

πŸ‡ΊπŸ‡¦ Show your support for Ukraine with some simple website banners.

Awesome Lists containing this project

README

          



Ukraine Banners



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.
```html

UKRAINE.init(["dark", "small", "bottom-right"]);
UKRAINE.createBanner();

```

## πŸ“– Usage

Firstly, clone the repository and install the dependencies.
```bash
git clone https://github.com/waveygroup/ukraine-banners.git && cd ukraine-banners && npm install
```

Now lets compile the JavaScript and CSS.
```bash
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.
```bash
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](https://github.com/waveygroup/ukraine-banners/stargazers) to the project.
2. Tweet about the project on your twitter.
3. Write a review or tutorial on [Medium](https://medium.com/), [Dev.to](https://dev.to/) or personal blog.
4. Support the project by pleding through [GitHub](https://github.com/sponsors/waveygroup). All donations will be donated to the [Ukrainian Red Cross](https://www.redcross.org.ua/en/).

## πŸ›‘οΈ Security Vulnerabilities

Please review our [security policy](https://github.com/waveygroup/ukraine-banners/security/policy) on how to report security vulnerabilities.

## ⚠️ License

Copyright (c) 2022-present [Wavey Group](https://github.com/waveygroup) and [Contributors](https://github.com/waveygroup/ukraine-banners/graphs/contributors). `Ukraine Banners` is free and open-source software licensed under the [MIT License](https://github.com/waveygroup/ukraine-banners/blob/master/LICENSE.md).