@littlefoxstudio/ioen-nft-badge
v0.0.8
Published
IOEN NFT viewer and badge
Downloads
9
Readme
IOEN NFT Web Component
An embeddable NFT viewer and IOEN supporter badge. Built as standalone Web Component using Stencil. It works in any major framework or with no framework at all.
Using this component
To use this component in your website or project, add the following to your <head>
tag:
<script type='module' src='https://unpkg.com/@littlefoxstudio/ioen-nft-badge'></script>
You can then use the component anywhere in your page template html, JSX, etc with
<ioen-nft-badge></ioen-nft-badge>
Use a specific version
To use a specific version of the component, simply append the version number to the src property in the script tag:
<script type='module' src='https://unpkg.com/@littlefoxstudio/[email protected]'></script>
Development Guide
Instructions on setting up your project locally, contributing to the code, and publishing a new release to npm.
Getting Started
To view the component locally, clone this repo and then run:
npm install
npm start
To build the component for production, run:
npm run build
To run the unit tests for the components, run:
npm test
Publishing a new version
To publish a new version of the component to npm, first you must increment the version number in package.json:
{
"name": "@littlefoxstudio/ioen-nft-badge",
"version": "0.0.7" // <-- Increment this number
...
},
Then run:
npm publish --access public
Roadmap
- [x] Responsive design
- [x] Dark mode support
- [ ] Automate the build and release process with Github actions
- [ ] Add prose styling to main CMS content
- [ ] Render 3D models
- [ ] Update tests
Credits
littlefox.studio for the design and initial implementation.