Welcome to HushMail Web3, where privacy meets blockchain in a dance of anonymous awesomeness! 🕺💃
- What's This All About?
- Features That'll Blow Your Mind
- Tech Stack: The Secret Sauce
- Getting Started: Your Journey Begins
- How to Use: Unleash the Power
- Contributing: Join the Privacy Party
- License: The Legal Stuff
HushMail Web3 is not your grandma's feedback platform. It's a cutting-edge, blockchain-powered system that lets you share your thoughts without revealing your identity. Think of it as a digital suggestion box on steroids! 💪
- 🕵️♀️ Anonymous Feedback: Share your thoughts without fear of judgment or repercussion.
- 🔗 Blockchain-Powered: Your feedback is stored on the Ethereum blockchain. It's like Fort Knox, but for your opinions!
- 🔐 End-to-End Encryption: Your messages are so secure, even we can't read them. It's like whispering, but cooler.
- ✅ Verified Responses: Ensure the authenticity of responses with blockchain verification. No more fake news!
- 🤖 AI-Assisted Posting: Writer's block? Our AI's got your back!
- 🌈 Interactive 3D UI: Because flat is so last year. Welcome to the third dimension!
Here's what makes HushMail Web3 tick:
- Next.js (v13+): The React framework on steroids. It's like React, but with superpowers!
- TypeScript: JavaScript, but with a safety helmet. No more "undefined is not a function" nightmares!
- Solidity: The language of smart contracts. It's like JavaScript had a baby with a blockchain.
- Ethereum: The blockchain that needs no introduction. It's like Bitcoin's cooler, more versatile cousin.
- IPFS: InterPlanetary File System. Because why store files on one planet when you can store them across the galaxy?
- Framer Motion: Animations so smooth, they'll make butter jealous.
- Tailwind CSS: Utility-first CSS framework. It's like Bootstrap, but you actually understand how it works.
- shadcn/ui: Beautiful, accessible UI components. It's like having a professional designer on your team, but cheaper.
- Three.js / React Three Fiber: 3D graphics in the browser. Because 2D is for squares (pun intended).
- Hardhat: Ethereum development environment. It's like a Swiss Army knife for blockchain devs.
- Ethers.js: Interact with the Ethereum blockchain. It's like jQuery for Web3.
- MongoDB: NoSQL database. It's like SQL, but it doesn't judge your life choices.
- NextAuth.js: Authentication for Next.js. It's like a bouncer for your app, but it doesn't have huge biceps.
Ready to dive into the world of anonymous feedback? Follow these steps:
-
Clone the repo:
git clone https://github.com/the-Sunny-Sharma/hushMail_Web3.git cd hushMail_Web3 -
Install dependencies:
npm install # or if you're a yarn fan yarn install -
Set up your environment variables: Create a
.env.localfile in the root directory and add your secret sauce:AUTH_SECRET=your_nextauth_secret GOOGLE_CLIENT_ID= GOOGLE_CLIENT_SECRET= MONGODB_URI=your_mongodb_connection_string PRIVATE_KEY=eth_nnetwork_mainet/sepolia-test-network SEPOLIA_URL = "https://sepolia.infura.io/v3/your_wallet_address" SEPOLIA_API_KEY=your_wallet_address NEXT_PUBLIC_CONTRACT_ADDRESS="0x11D43FEB011E783C6417D6F514f467D648B73B5f" GEMINI_API_KEY = gemini_api_key # Add any other environment variables -
Fire up the development server:
npm run dev # or yarn dev -
Open your browser and navigate to
http://localhost:3000. Welcome to the future of feedback!
- Sign Up: Create an account using your email or connect your Ethereum wallet.
- Create a Feed: Start a new feedback thread. It's like creating a Twitter thread, but private and on the blockchain.
- Share Feedback: Pour your heart out. Our AI assistant is there if you need inspiration.
- Interact: Respond to feedback, but remember, with great power comes great responsibility!
- Explore: Check out the 3D visualizations of the HushMail ecosystem. It's like a virtual tour, but without the annoying guide.
We're always looking for privacy enthusiasts and blockchain buffs to join our ranks! If you've got ideas, bug fixes, or just want to add more emojis to our README, here's how:
- Fork the repo
- Create your feature branch (
git checkout -b feature/AmazingFeature) - Commit your changes (
git commit -m 'Add some AmazingFeature') - Push to the branch (
git push origin feature/AmazingFeature) - Open a Pull Request
This project is licensed under the MIT License - see the LICENSE.md file for details. It's like a prenup, but for code.
Built with ❤️ and a lot of ☕ by the HushMail Web3 team under the guidance of Prof. Sanketi Raut. May your feedback be honest and your identity remain a mystery! 🎭