Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/warengonzaga/thirdweb-wp

A community WordPress plugin for thirdweb. Turn your WordPress website into Web3 instantly and easily with thirdweb. 🚀đŸ’ģ🧩
https://github.com/warengonzaga/thirdweb-wp

blockchain engine plugin smartcontract thirdweb web3 wordpress wordpress-plugin

Last synced: 7 days ago
JSON representation

A community WordPress plugin for thirdweb. Turn your WordPress website into Web3 instantly and easily with thirdweb. 🚀đŸ’ģ🧩

Awesome Lists containing this project

README

        

# thirdweb WP 🧩 [![author/maintainer](https://img.shields.io/badge/by-Waren%20Gonzaga-016eea.svg?logo=github&labelColor=181717&longCache=true&style=flat-square)](https://warengonzaga.com) [![nominate](https://img.shields.io/badge/nominate-%20@warengonzaga%20as%20GitHub%20Star-yellow.svg?logo=github&labelColor=181717&longCache=true&style=flat-square)](https://stars.github.com/nominate)

[![made in](https://img.shields.io/badge/made%20in-Open%20Source%20Software%20PH-0060a0.svg?logo=github&longCache=true&labelColor=181717&style=flat-square)](https://github.com/ossphilippines) [![sponsors](https://img.shields.io/badge/sponsor-%E2%9D%A4-%23db61a2.svg?&logo=github&logoColor=white&labelColor=181717&style=flat-square)](https://github.com/sponsors/warengonzaga) [![release](https://img.shields.io/github/release/warengonzaga/thirdweb-wp.svg?logo=github&labelColor=181717&color=green&style=flat-square)](https://github.com/warengonzaga/thirdweb-wp/releases) [![star](https://img.shields.io/github/stars/warengonzaga/thirdweb-wp.svg?&logo=github&labelColor=181717&color=yellow&style=flat-square)](https://github.com/warengonzaga/thirdweb-wp/stargazers) [![license](https://img.shields.io/github/license/warengonzaga/thirdweb-wp.svg?&logo=github&labelColor=181717&style=flat-square)](https://github.com/warengonzaga/thirdweb-wp/blob/main/license)

[![banner](.github/repo_banner.jpg)](https://wordpress.org/plugins/thirdweb-wp)

A community WordPress plugin for **[thirdweb](https://thirdweb.com)**. Turn your WordPress website into Web3 instantly and easily with thirdweb. Powered by thirdweb Engine. 🚀đŸ’ģ🧩

Have suggestions in mind? [Let me know!](https://github.com/warengonzaga/thirdweb-wp/issues)

## ⚡ Features

- Contract Reading Shortcode
- Contract Writing Shortcode _(Coming Soon)_
- Gutenberg Blocks _(Coming Soon)_

## 📋 Requirements

- [thirdweb Engine URL](https://portal.thirdweb.com/engine/getting-started)
- [thirdweb Engine Access Token](https://thirdweb.com/dashboard/engine)
- WordPress 5.0+
- PHP 7.4+

## đŸ“Ļ Installation

To be able to start using this plugin just [download the latest release here](https://github.com/warengonzaga/thirdweb-wp/releases/latest).

- Upload the plugin (.zip file) to the /wp-content/plugins/ directory.
- Activate the Update Your Footer WP plugin through the 'Plugins' menu in WordPress.
- See the usage section below to start using the plugin.

## 🛠ī¸ Setup

1. Go to your WordPress admin dashboard.
2. Go to `Settings > thirdweb WP`.
3. Save your thirdweb Engine URL and Access Token.
4. Click `Save Changes`.
5. You're all set! 🎉

> [!NOTE]
> You can also save your default or global address and chain across your wordpress site. Just go to `Settings > thirdweb WP` and fill the `Default Contract Address` and `Default Chain` fields. Click `Save Changes` to save your settings.

## 🕹ī¸ Usage

Reading contract address using `[contract]` shortcode.

```php
[contract address="0x00..." chain="84531" function="tokenURI:0"]
```

- `address` - The contract address.
- `chain` - The chain name or ID.
- `function` - The function name and arguments.

> [!NOTE]
> `functionName:arg1` for single argument or `functionName:arg1,arg2` for multiple arguments. If you saved your default contract address and chain, you can omit the `address` and `chain` attributes.

_More features coming soon..._

## đŸŽ¯ Contributing

Contributions are welcome, create a pull request to this repo and I will review your code. Please consider to submit your pull request to the `dev` branch. Thank you!

Read the project's [contributing guide](./contributing.md) for more info.

## 🐛 Issues

Please report any issues and bugs by [creating a new issue here](https://github.com/warengonzaga/thirdweb-wp/issues/new/choose), also make sure you're reporting an issue that doesn't exist. Any help to improve the project would be appreciated. Thanks! 🙏✨

## 🙏 Sponsor and Support

> Love what I do? Send me some [love](https://github.com/sponsors/warengonzaga) or [coffee](https://buymeacoff.ee/warengonzaga)!? 💖☕
>
> Can't send love or coffees? đŸ˜Ĩ Nominate me for a **[GitHub Star](https://stars.github.com/nominate)** instead!
> Your support will help me to continue working on open-source projects like this. 🙏😇

## 📋 Code of Conduct

Read the project's [code of conduct](./code_of_conduct.md).

## 📃 License

This project is licensed under [GNU General Public License v3.0](https://opensource.org/licenses/GPL-3.0).

## 📝 Author

This project is created by **[Waren Gonzaga](https://github.com/warengonzaga)**, with the help of awesome [contributors](https://github.com/warengonzaga/thirdweb-wp/graphs/contributors).

[![contributors](https://contrib.rocks/image?repo=warengonzaga/thirdweb-wp)](https://github.com/warengonzaga/thirdweb-wp/graphs/contributors)

---

đŸ’ģ with ❤ī¸ by [Waren Gonzaga](https://warengonzaga.com) and [Him](https://www.youtube.com/watch?v=HHrxS4diLew&t=44s) 🙏