diff --git a/README.md b/README.md index e6cf32e..439c2d3 100644 --- a/README.md +++ b/README.md @@ -1,65 +1,54 @@ -Social dapp that allows users to monetize ๐Ÿ›’ their social activity ๐Ÿซ‚. +Social dapp that allows users to monetize ๐Ÿ’ฐ their social activity ๐Ÿซ‚. - ๐Ÿ’ฌ We don't show ads - ๐Ÿ“Š We don't sell your data -- ๐Ÿ’ฐ You can earn from your social activity # ๐Ÿค˜ Features - ๐Ÿคนโ€โ™‚๏ธ Posts can have text, image, audio, video and links. +- ๐Ÿ’ฐ Liking, commenting and sharing send $ to the user on the other end +- ๐Ÿ“ˆ Track and analyze revenue on your dashboard. +- ๐Ÿ›’ Shopping cart: Do multiple actions in a single transaction. - ๐Ÿ”” Receive notifications on activity. - ๐Ÿ’Œ Message other users. -- ๐Ÿ’ฐ Liking, commenting, sharing and following send $ to the user on the other end -- ๐Ÿ›’ Shopping cart: Do multiple actions in a single transaction. -- ๐Ÿ“ˆ Track and analyze revenue on your dashboard. -- ๐ŸŽจ Customize your profile colors and appearance. -- ๐Ÿ“š Built-in guides to help users understand Web3 and NFT minting. -- ๐Ÿง‘โ€๐Ÿฆฝ Accessibility for visually impaired users. # ๐Ÿค˜ Roadmap ## ๐Ÿฃ Phase 1 (MVP) - โœ… **Create PunkPosts contract** -- โœ… **Create ProfileInfo contract for users to register their info** -- โœ… **Post creation page** +- โœ… **Create PunkProfile contract to register users info and socials** +- โœ… **Post creation tool** - โœ… **User profile page** -- โœ… **View other users profiles** ## ๐Ÿ‘ฅ Phase 2 (Social Activity and Indexing) -- **Social features:** Following users, liking, commenting and sharing posts. -- **Search**: By address, ENS or username -- **Individual post pages** for displaying long texts and big images +- โœ… **PunkSociety contract:** Following users, liking, commenting and sharing posts. +- **Search**: By address or username - **Notification system** - **Integrate The Graph to index activity** and save RPC calls (Reference: [Bootstrap a Full Stack Modern dapp using the Scaffold-ETH CLI and Subgraph Extension](https://siddhantk08.hashnode.dev/bootstrap-a-full-stack-modern-dapp-using-the-scaffold-eth-cli-and-subgraph-extension) | [The Graph tool for creating a subgraph](https://thegraph.com/docs/en/developing/creating-a-subgraph/)) +- Enable audio, video and links with preview type of posts. +- **Individual post viewer** ## ๐Ÿ€ Phase 3 (Incentivized socials) -- **Incentive model**: Likes, comments, shares and follows send $ to the user on the other end. +- **Incentive model**: Likes, comments and shares send $ to the user on the other end. - **Dashboard Insights**: Track and analyze revenue. -- **Revenue Model**: PunkSociety collects fees. +- **Revenue Model**: PunkSociety collects fees from interactions. -## ๐ŸŽจ Phase 4 (Customization and ease of use) +## ๐Ÿ’Œ Phase 4 (Direct messages) -- **Post Collections**: Create and share collections on galleries visibles from user profiles. -- **Profile Customization**: Users can customize colors and profile appearance. -- **Shopping cart**: To reduce gas fees and streamline the user experience, users can send multiple actions in a single transaction. -- **Educational Content**: Include onboarding tutorials and step-by-step guides to help users and collectors understand NFTs and Web3 concepts. +- **Direct messages:** Allow users to send private messages to each other -## ๐Ÿ’Œ Phase 5 (Direct messages) +## ๐ŸŽจ Phase 5 (Ease of use) -- **Direct messages:** Allow users to send private messages to each other +- **Shopping cart**: To reduce gas fees and streamline the user experience, users can send multiple actions in a single transaction. +- **Educational Content**: Include onboarding tutorials and step-by-step guides to help users and collectors understand NFTs and Web3 concepts. ## โœ๏ธ Phase 6 (Gasless activity) - **Signatures:** Allow users to interact with the platform without paying gas fees - **Database:** To store and retrieve EIP 712 signatures (Reference: [SE-2 firebase-auth-extension](https://github.com/ByteAtATime/firebase-auth-extension)) -- **Whitelist:** Optional system to validate users to prevent spam - -## ๐Ÿง‘โ€๐Ÿฆฝ Phase 7 (Accessibility) - -- **Accessibility support**: Website must be [ARIA compliant](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA) # ๐Ÿค˜ Development