Skip to content

Latest commit

 

History

History
142 lines (107 loc) · 7.55 KB

README.md

File metadata and controls

142 lines (107 loc) · 7.55 KB
Raw

WeaveNFTChat 🌿

Welcome to the WeaveNFTChat repository! Our cutting-edge Group NFT Chat application aims to revolutionize social engagement within the NFT ecosystem, with a specific focus on use cases such as Airdrops. 🚀🌐

Overview

WeaveNFTChat is a state-of-the-art Group NFT Chat application that provides users with a unique platform to interact and engage with their NFTs in various social groups. Powered by Weave DB relayers and the Lit Protocol, our application is set to redefine the standards for cross-chain messaging, ensuring seamless and efficient communication across different blockchain networks. 💬✨

Features

  • Group NFT Chat: Engage and interact with your NFTs in dedicated social groups.
  • Cross-Chain Messaging: Seamlessly communicate across different blockchain networks.
  • Decentralized Database: Safeguard user data and conversations with Weave DB's decentralized capabilities.
  • Secure Chat Environment: Foster a secure chat environment with robust access control using the Lit Protocol.
  • Simplified User Onboarding: Use popular authentication methods like Google OAuth and WebAuth for easy sign-up.
  • Comprehensive Social Graph: Explore your social interactions within the NFT landscape with the Lens social graph protocol.
  • Immutable Message Storage: Ensure the durability and permanence of user messages with Arweave integration.

Technology Integrations

Technology Description
Weave DB Facilitates cross-chain messaging and decentralized database capabilities.
Lit Protocol Provides access control logic and fosters a secure chat environment.
Arweave Ensures the immutability and long-term storage of user messages.
Lens Offers a comprehensive social graph for visualizing social interactions within the NFTs.
Fleek Our Application hosted on Fleek https://ipfs.io/ipfs/QmZgagRUJvbcqTiTLUufw1dvW8hA9ieaQt6vLZgTrECSqd

Use Cases

  • NFT Airdrops: Facilitate seamless communication and engagement during NFT Airdrop campaigns.
  • Social NFT Communities: Provide a dedicated space for NFT collectors and enthusiasts to connect and interact.
  • Collaborative Projects: Foster collaboration and communication among users working on NFT-related projects.

Our Group NFT Chat application promises an exciting fusion of social interaction, digital assets, and cutting-edge technology. Join us on this revolutionary platform to share, explore, and engage within the vibrant NFT community, with a specific focus on various usecases 🌟💬🎉

By harnessing the power of these advanced technologies, we're excited to unlock new possibilities within the NFT landscape and redefine the future of digital social engagement. 🚀✨

🚀 Project Structure

/
├── abi/
│   └── lenshub.json
│   └── lensperiphery.json
├── api/
│   └── index.js
│   └── mutations.js
│   └── queries.js
├── components/
│   └── index.js
│   └── ...
├── pages/
│   └── profile/
│   └── index.js
│   └── _app.js
│   └── ...
├── public/
│   └── ...
├── styles/
│   └── ...
└── package.json
└── ...

🧞 Commands

All commands are run from the root of the project, from a terminal:

Command Action
pnpm install Installs the project dependencies
pnpm run dev Starts local dev server at localhost:3001
pnpm run build Build your production site to ./out/
pnpm run start Preview your build locally, before deploying
pnpm run lint Runs eslint

Run the project

This project has a dependency on having a Infura IPFS API Key used on uploadToIPFS().
Setup your Infura keys in env.local. You can check example.env.local for reference.

You can checkout Lens documentation and available functions.

The main API calls used in this app are defined in api/index.js:

Method Result
recommendProfiles Get popular profiles
getProfiles Get profiles by passing in an array of profileIds
getPublications Returns a list of publications based on your request query
searchProfiles Allows a user to search across hashtags on publications or profile handles. This query returns either a Post and Comment or Profile.
follow Follow a user
burn Unfollows a user
timeline Shows a feed of content tailored to a signed in user
createSetProfileMetadataTypedData Allows a user to update the metadata URI for their profile
post Allows a user to publish content

⚡ How to deploy to Fleek

1. Create a fleek.json config file:

You can configure this site deployment using Fleek CLI and running:

 > fleek sites init
  WARN! Fleek CLI is in beta phase, use it under your own responsibility
   ? Choose one of the existing sites or create a new one. › 
    ❯ Create a new site

It will prompt you for a name, dist directory location & build command

  • name: How you want to name the site
  • dist: The output directory where the site is located, for this template it's dist
  • build command: Command to build your site, this will be used to deploy the latest version either by CLI or Github Actions

2. Deploy the site

After configuiring your fleek.json file, you can deployt the site by running

fleek sites deploy

After running it you will get an output like this:

 WARN! Fleek CLI is in beta, use it at your own discretion
  > Success! Deployed!
   > Site IPFS CID: QmTf8fUabGohaRztcbXuZCEZ46hrRrCswVPYrquLezWFRF

    > You can visit through the gateway:
     > https://ipfs.io/ipfs/QmTf8fUabGohaRztcbXuZCEZ46hrRrCswVPYrquLezWFRF

Extra features

Build3rs Stack Lens Protocol

You can learn more about Lens visiting our Build3rs Stack - web3 infrastructure overview series in the official Fleek Blog. Where we provide a developer guide to start to build with it.