Skip to content

sejals23/truth-tunnel

 
 

Repository files navigation

📦 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.

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=""
NEXTAUTH_SECRET=""
EMAIL_USER=""
EMAIL_PASS=""
  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/scruter.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

  • We extend our heartfelt gratitude for your invaluable contribution to our project! Your efforts play a pivotal role in elevating this project to greater heights.
  • Make sure you show some love by giving ⭐ to our repository.

Contact

For any queries or issues, please reach out to:

Made with ❤️ by Mitul Sonagara.

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 98.3%
  • CSS 1.2%
  • Other 0.5%