Skip to content

Latest commit

 

History

History
47 lines (25 loc) · 2.06 KB

README.md

File metadata and controls

47 lines (25 loc) · 2.06 KB

RMRK Composable NFT creator

A simple no-code UI for creating your own composable NFTs using RMRK EVM NFTs standard.


Usage

TODO: add vercel link here when available

Development

Install modules and start dev server

Install dependencies

pnpm install

Copy sample env file by running cp env.example .env.local and fill in the relevant environment variables

Run nextjs dev server

pnpm dev

Styling

This project uses Panda.css for core styling and Panda's component library Ark.ui as well as Park-ui for a ready to use components. When you need a new component, please look at park-ui website first to see if it's already included. Park-ui is based on ArkUI, and often times the documentation for component properties and events is more detailed on Ark UI website. When running the dev server, styles will automatically re-generate using postcss when appropriate files are changed, however if you need to manually generate styles, run pnpm panda.

Lucide is used for icons.

Interacting with blockchain

wagmi for react hooks etc and viem for framework agnostic utils.

Other notes

This project uses Biome.js for code formatting (instead of prettier) and linting. Biome IDE plugins have options to run on save (both vscode and intellij), I recommend turning it on. But to run both formatting and linting at any time manually, you can run pnpm format && pnpm lint:fix. Please visit Biome.js website to see how to install and use biome IDE plugin.

Live test UI

Still a test UI, and few things to improve. But you can play around with it already Catalog creator: https://rmrk-composable-nft-creator.vercel.app/ Singular build where you can add catalog to asset (for parent NFT) and equippable asset (for child nft): https://singular-rmrk2-git-feat-composable-asset-entry-test-rmrk-team.vercel.app/

Contributing

Try to include a single feature per pull request whenever possible.