Giter Site home page Giter Site logo

unlock-protocol / flocker Goto Github PK

View Code? Open in Web Editor NEW
7.0 4.0 2.0 1.23 MB

Flocker helps you bring your Twitter followers with you to web3 with an Unlock-powered membership smart contract.

Home Page: https://www.flocker.app/

License: MIT License

JavaScript 0.99% TypeScript 98.78% CSS 0.23%
ethers nextjs nfts nodejs react twitter unlock unlock-protocol web3 wagmi

flocker's Introduction

Flocker.app

Flocker helps you bring your Twitter followers with you to web3 with an Unlock-powered membership smart contract.

Flocker

Getting Started

Setting up environment

  1. Rename the .env.local.template to .env.local file.
  2. Fill out the environment variables. For example, TWITTER_BEARER_TOKEN is required to interact with twitter API. You can get one by applying for a developer account and creating an application.

Develop

This is a Next.js project bootstrapped with create-next-app.

First, run the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.tsx. The page auto-updates as you edit the file.

API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.ts.

The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.

flocker's People

Contributors

ccarfi avatar julien51 avatar searchableguy avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

flocker's Issues

add more context below the flocker call to action without distracting from it

Suggest adding a styled version of this copy below the existing copy and call to action on the flocker.app homepage

Screen Shot 2022-11-23 at 7 43 29 AM

feel free to choose the right heading weight for the title (H2 might not be correct)
feel free to style the green checks differently
feel free to use UL or other similar element for the list of "places" such as Discord, etc.

----- copy below this line -----

Get your flock off of Twitter

Flocker helps you bring your Twitter followers with you to Web3 with an Unlock-powered membership smart contract.

✅ Enter your Twitter handle
✅ Create a free membership (smart contract)
✅ Share the link to claim your membership card with your Twitter followers
✅ Your followers claim your free membership
✅ Connect with them on any service that supports token-gated access

Places where your followers can connect with you include:

  • Discord
  • Telegram
  • Paragraph
  • Guild.xyz
  • Highlight
  • Tropee
  • WordPress

...and more.

Flocker is a project from Unlock Labs and uses <a href="https://www.unlock-protocol.com">Unlock Protocol</a>. Learn more about the thinking behind Flocker <a href="https://twitter.com/julien51/status/1594836533974122496">here</a>.

Use a contract creator's Twitter profile picture as the default image for Flocker checkout

Is your feature request related to a problem? Please describe.
When claiming a membership, users see the Unlock logo instead of a Twitter account's profile picture.

Describe the solution you'd like
Add the Twitter profile picture from the membership contract creator to the Checkout flow.

Describe alternatives you've considered
Add an 'Edit Purchase URL' CTA pointing to Checkout Builder on the page post-deployment and/or on the Flocker homepage after a membership contract has been deployed.

Add token gating

Let's add a setting for the user to chose if all the links should be public or if they should be token gated.

Point users to their 'Where to find me' Flocker page

Is your feature request related to a problem? Please describe.
After deploying a membership contract, it isn't clear where a user's 'Where to find me' page is.

Describe the solution you'd like
Include a link that points to a user's 'Where to find me' page.

Describe alternatives you've considered
Point 'Share' to a user's 'Where to find me' page.

Screen Shot 2022-11-22 at 12 38 14 PM

Add Flocker Profile link to 'Your membership contracts'

Is your feature request related to a problem? Please describe.
When users come back to Flocker, it isn't clear where there permalink is. Users need this to share with their followers.

Describe the solution you'd like
Add a pointer to the flocker profile under 'Your membership contracts'

Describe alternatives you've considered
After creating a membership contract, default to the Flocker profile created with an 'Edit Attributes' CTA.

Add a share CTA under the 'Edit Attributes' CTA

2022-11-21 17 29 04

Rate limiting

We may want to rate limit to make sure people are not able to abuse since we don't actually "link" Twitter accounts.
The easiest way to do that which does not require us to store special state is to look at the subgraph for any user for whom we are about to create a lock and prevent them from doing it if they have create another lock less than say 1 hour ago?
In the subgraph, we keep the time (at least block number) for each lock created.

Flocker: Purchase URL

Is your feature request related to a problem? Please describe.
It's unclear to users whether their followers need to claim membership or if there is a claim process.

Describe the solution you'd like
Add Buttons with 'Claim a Membership' and 'Share Your Memberships', replacing the Purchase URL

Describe alternatives you've considered
Just a 'Share Your Memberships' Button

Additional context
Screen Shot 2022-12-09 at 2 47 53 PM

Flocker 'Deploy membership contract' introduces 'deploy' without context

Is your feature request related to a problem? Please describe.
Creators on Flocker are asked to 'Deploy membership contract'. The term 'deploy' is not common and may not be understood by non-technical users.

Describe the solution you'd like
The 'Deploy membership contract' CTA should be revised to 'Create membership contract' to align with the copy on Flocker.

Describe alternatives you've considered
'Create memberships'

Screen Shot 2022-11-22 at 4 14 44 PM

Use ENS for shorter names/URL

We could let flocker users who have an ENS use the latter as a short code. For this they would only need to register a text record pointing to the network + contract address.

Add abritrary links

We currently only support a single link. Let's allow users to add arbitrarily links (+ labels)

"Claim membership" button

Right now we show a claim membership button in any case, even if the user already has a membership.
Let's replace with a "Connect wallet" button and only show "claim" membership if applicable!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.