Code Monkey home page Code Monkey logo

jekyll-crypto-donations's Introduction

Jekyll::CryptoDonations ๐Ÿค‘

Gem Version

About

The Jekyll Crypto Donations plugin is a simple and efficient solution for integrating cryptocurrency donations into Jekyll-generated websites. In the initial iteration, the plugin supports Bitcoin (BTC), Ethereum (ETH), and USDT (TRC-20). It allows website owners to display current donation amounts and provide easy access for visitors to contribute using these cryptocurrencies. The plugin is designed to be easy to install and configure, making it a seamless addition to any Jekyll site. By leveraging real-time API calls, it ensures that the displayed donation amounts are always up-to-date, providing transparency and encouraging more contributions.

Installation

Add to your Gemfile:

group :jekyll_plugins do
  gem 'jekyll-crypto-donations' 
end

Usage

Add donation addresses to your _config.yaml

crypto_donations:
  btc_address: "YOUR_BTC_ADDRESS"
  eth_address: "YOUR_ETH_ADDRESS"
  usdt_address: "YOUR_USDT_TRC20_ADDRES"

Use {% crypto_donations %} or {% crypto_donations Any text you can share with donations block %} at the jekyll page source.

Demo

To see the Crypto Donations plugin in action, check out the demo on my website: madmatvey.github.io.

You can see how the donation addresses and total received amounts are displayed for Bitcoin (BTC), Ethereum (ETH), and USDT (TRC-20). The demo showcases the real-time integration and functionality of the plugin.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Use NodeJS version 20 LTS

$ nvm use 20 --lts

install Typescrypt: npm install typescript

Do not change assets/js/crypto-donations/crypto-donations.js manually, make changes with TS at src/crypto-donations/crypto-donations.ts and then run:

$ npx tsc

local gem build: gem build jekyll-crypto-donations.gemspec

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/madmatvey/jekyll-crypto-donations.

License

The gem is available as open source under the terms of the MIT License.

jekyll-crypto-donations's People

Contributors

madmatvey avatar

Stargazers

 avatar

Watchers

 avatar

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.