builderz-labs/renaissance-xnft

A seamless Royalty Solution for NFT communities to track and redeem royalties

Re:naissance

A seamless Royalty Solution for NFT communities to track and redeem royalties 👑

Built on Backpack 🎒

🔗 Link: https://builderz.dev

🎥 Demo: https://vimeo.com/808021937

🐤 Twitter: https://twitter.com/renaissance_xyz

💬 Discord: https://discord.gg/eMKXtKu6P9

🤝 Contribute

• Fork Renaissance onto your own GitHub
• Clone it and checkout the dev branch (git checkout dev)
• Create a new branch named [initials]/[feature] off of dev. Example q/added-a-cool-thing.
• When ready for us to review your changes, create a PR with your new branch to be merged into the dev branch on the official xNFT.

Recommended VSCode Extensions

• ESLint
• Prettier
• Better Comments

Tech Stack

• Node
• TypeScript
• tRPC
• TanstackQuery
• Tailwind
• DaisyUI Components
• Material UI

Setup Environment

To work with our project you need to pass in a Helius API and RPC Proxy URL in the .env file In the root of the project, create a .env file with the following values:

VITE_HELIUS_RPC_PROXY=<PROXY_URL>

---

Note You can learn how to create a proxy for your HELIUS Plan HERE

---

Install

Run the install command from the root of the project to install dependencies for all apps and packages.

yarn install

Dev

Start all packages and apps in dev mode which watches for changes and adds your local environment.

yarn

Lint

It's recommended you use VSCode because if you do, ESLint is setup to auto fix/format as you're working.

yarn lint

Format

Formats files based on the Prettier and ESlint settings.

yarn

Test

Tests the code, determines if it should be allowed to merge. We recommend running this locally before creating PRs.

yarn

Build

Build all apps and packages for production.

yarn build

Styles

TailwindCSS is used for base utilies and DaisyUI contains helpful UI components.

Icons

Material Icons