Skip to content

Latest commit

 

History

History
198 lines (137 loc) · 6.78 KB

README.md

File metadata and controls

198 lines (137 loc) · 6.78 KB

📦 Truth-Tunnel Web Application 🛡️

Hi there, Welcome to secure and anonymous messaging!

Truth-Tunnel is a web application that allows users to send and receive messages securely while maintaining anonymity. With a robust login system featuring OTP (One-Time Password) verification, your safety and privacy are our top priority.

This project is now OFFICIALLY accepted for

GSSoC 2024 Extd Hacktoberfest 2024

Overview 📌

  • 🔒 Anonymous Identity: Users can communicate without revealing their identity.
  • 📧 Secure OTP Login: Verifies user identity via OTP sent to their email.
  • 🔐 Encrypted Messaging: Ensures privacy with end-to-end message encryption.
  • 💻 Cross-Platform: Accessible on web and mobile devices.
  • ✨ User-Friendly Interface: Simple, clean, and intuitive design.

Truth-Tunnel Preview

Live Demo 🎥

Access the live version of Truth-Tunnel at truth-tunnel.vercel.app.

Technologies Used

Truth-Tunnel is built using the following technologies:

  • Frontend:
    • Next.js
    • TailwindCSS
    • shadcn
  • Backend:
    • Node.js
    • Express.js
  • Database:
    • MongoDB
  • Security:
    • next/auth for authentication
    • OTP (One-Time Password) for verification
    • bcrypt for password hashing

Prerequisites 👈🏻

Before setting up the project, ensure you have the following installed:

Installation 🛠️

Follow these steps to set up Truth-Tunnel locally:

  1. Clone the repository:
git clone https://github.com/MitulSonagara/truth-tunnel.git
cd truth-tunnel
  1. Install dependencies:
npm install
  1. Set up environment variables:

    Create a .env file in the root directory and configure the following variables:

DATABASE_URL= #Prisma Database url
NEXTAUTH_SECRET= #Any Secret code for next auth secret
EMAIL_PASS= #App password for your email account from which you want to send the email
EMAIL_USER= #Email address from which you want to send the email
NEXTAUTH_URL=http://localhost:3000
GOOGLE_CLIENT_ID= #Your Google client ID
GOOGLE_CLIENT_SECRET= #your Google client secret
  1. Build the application:
npm run build
  1. Run the application:
npm start

Contributing 🌟

Contributions are welcome! Follow these steps to contribute:

Fork the repository

Click the "Fork" button at the top-right corner of the repository page to create a personal copy.

Clone your forked repository

git clone https://github.com/your-username/truth-tunnel.git
cd scruter

Create a new branch

git checkout -b feature-branch-name

Add your changes

git add .

Make your changes and commit them

git commit -m 'Add some feature'

Push to the branch

git push origin feature-branch-name

Submit a pull request

Go to the original repository and click on the "Pull Request" button to submit your changes.

Please refer to the Contributing.md file for detailed guidelines on how to contribute to this project.

Our Contributors

Thank you for contributing to our repository

Contributors

👥 Team

Mitul Sonagara
Mitul Sonagara
Project Admin
LinkedIn

For any inquiries or feedback, please contact. Happy Contributing 🫡

⭐️ Support the Project

If you find this project helpful, please consider giving it a ⭐ on GitHub! Your support helps to grow the project and reach more contributors.

Made with ❤️ by Mitul Sonagara.