README.md

Collect3.me

This is a Web3 project with the goal to save your favorite content FOREVER!

Website · Download beta · Report Bug · Request Feature

📔 Table of Contents

• About the Project
  • Screenshots
  • Tech Stack
  • Features
  • Color Reference
  • Environment Variables
• Getting Started
  • Prerequisites
  • Installation
  • Running Tests
  • Run Locally
  • Deployment
• Usage
• Roadmap
• Contributing
  • Code of Conduct
• FAQ
• License
• Contact
• Acknowledgements

🌟 About the Project

Collect3 is a browser plugin that empowers users to eternalize digital content like articles or posts using web3 and decentralized storage. Unlike traditional bookmarks or saved PDFs, Collect3 allows users to mint and store reader-friendly versions of the content on the dex storage, ensuring permanence and true ownership and doc sharing. This solves the problem of content loss due to website changes, discontinuations, or censorship, offering a robust, decentralized solution for preserving valuable information.

📷 Demo

👾 Tech Stack

Client

• Typescript
• Next.js
• React.js
• TailwindCSS

Server

• Typescript
• Express.js

Database

• MongoDB

DevOps

• Docker

🎯 Coming Features

• Save articles as NFTs
• Keep the Articles forever storing them into Decentralized Storage
• Share your articles with other users!
• Add comments into the articles
• Read other owners comments of the same article
• Resell the articles!

🧰 Getting Started

‼️ Prerequisites

This project uses Yarn as package manager

 npm install --global yarn

🏃 Run Locally

Clone the project

  git clone https://github.com/8infinitelabs/collect3.git

Go to the project directory

  cd my-project/packages/extension

Install dependencies

  yarn install

Then you can build the extension

    yarn build

And finally you can install it this way

or you can execute

    yarn start

if you are going to make changes to the code

🧭 Roadmap

• Create plugin browser
• Get a Read-mode view for articles
• Save them in Local Browser (temporally storage)
• Create an NFT
• Improve Read-mode view
• Store the content into decentralized storage
• Share your articles!
• Add comments into the article
• Read comments from any other article owners
• Boost article discussions
• Sell articles NFTs to other users
• Marketplace for articles

👋 Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

📜 Code of Conduct

Please read the Code of Conduct

⚠️ License

Distributed under the no License. See LICENSE for more information.

🤝 Contact

Diego Torres - @twitter_handle - diego@infinitelabs.co

Project Link: https://github.com/8infinitelabs/collect3

💎 Acknowledgements

Use this section to mention useful resources and libraries that you have used in your projects.

• Shields.io
• Awesome README
• Emoji Cheat Sheet
• Readme Template