👋 Welcome! This demo app was created to help you learn how to build on Flow.
- Kitty Items is a complete NFT marketplace built with Cadence, Flow's resource-oriented smart contract programming language.
- Learn how to deploy contracts, mint NFTs, and integrate user wallets with the Flow Client Library (FCL).
Check out the live demo of Kitty Items, deployed on IPFS and the Flow Testnet.
Before you start, install the Flow command-line interface (CLI).
You'll need a Testnet account to work on this project. Here's how to make one:
- Generate a new key pair with the Flow CLI:
flow keys generate(⚠️ Make sure to save these keys in a safe place, you'll need them later.) - Go to the Flow Testnet Faucet to create a new account. Use the public key from the previous step.
- After a short time, you'll receive an email with your newly-created Flow account address.
git clone [email protected]:onflow/kitty-items.gitOnce you have the project files, you'll find setup instructions in the README.md files inside each folder.
Follow the deployer instructions to deploy the Kitty Items Cadence contracts to your Testnet account.
After the contracts are deployed, follow the kitty-items-js instructions to install and run the Kitty Items API. This backend service is responsible for initializing accounts, minting NFTs, and processing events.
Lastly, follow the kitty-items-web instructions to launch the Kitty Items front-end React app.
Above is a basic diagram of the parts of this project contained in each folder, and how each part interacts with the others.
Flow is a next-generation blockchain platform that is designed to be fast and easy to use. If you're new to Flow, consider reading more about it in the Flow Primer, or visit the developer documentation.
2. Web App (Static website) | kitty-items-web
A true dapp, client-only web app. This is a complete web application built with React that demonstrates how to build a static website that can be deployed to an environment like IPFS and connects directly to the Flow blockchain using @onflow/fcl. No servers required. @onflow/fcl handles authentication and authorization of Flow accounts, signing transactions, and querying data using using Cadence scripts.
3. Look Ma, a Web Server! | kitty-items-js
We love decentralization, but servers are still very useful, and this one's no exception. The code in this project demonstrates how to connect to Flow using Flow JavaScript SDK from a NodeJS backend. It's also chalk-full of handy patterns you'll proabably want to use for more complex and feature-rich blockchain applications, like storing and querying events using a SQL database (Postgres). The API demonstrates how to send transactions to the Flow Blockchain, specifically for minting Kibbles (fungible tokens) and Kitty Items (non-fungible tokens).
4. Cadence Code | kitty-items-cadence
Cadence smart contracts, scripts & transactions for your viewing pleasure. This folder contains all of the blockchain logic for the marketplace application. Here you will find examples of fungible token and non-fungible token (NFT) smart contract implementations, as well as the scripts and transactions that interact with them. It also contains examples of how to test your Cadence code (tests written in Golang).
5. Development Helpers | kitty-items-deployer
Useful utilities for automating development related tasks like bootstrapping accounts and deploying contracts. Look through this project for an idea of what it's like to bootstrap your Flow accounts and Cadence smart contracts onto the Flow Emulator or Flow Testnet.
An @onflow/fcl compatible wallet service that helps @onflw/fcl perform authentication and authorization of Flow accounts.
Items are hats for your cats, but under the hood they're non-fungible tokens (NFTs) stored on the Flow blockchain.
Items can be purchased from the marketplace with fungible tokens. In the future you'll be able to add them to Ethereum CryptoKitties with ownership validated by an oracle.
- Chat with the team on the Flow Discord server
- Ask questions on the Flow community forum
🚀 Happy Hacking!