Skip to content

Fardeen26/ghostgram

Repository files navigation

OrbitToken

📖 Introduction

Ghostgram is an anonyms messaging platform that allow uses to receive or send message without revealing their identity.

🛠️ Technologies Used

  • Next.js
  • TypeScript
  • MongoDB
  • Gemini AI
  • Nodemailer
  • NextAuth
  • React Hook Form
  • Shadcn UI
  • Tailwind CSS

🚀 Getting Started

Cloning the Repository

To clone the repository locally, use the following commands:

git clone https://github.com/your-username/ghostgram.git 
cd ghostgram

Installation

npm install

Configuration

Create a .env file in the root folder of your project. Update it following the convention of the .env.example file. Here's an example:

MONGODB_URL=
NEXT_AUTH_SECRET=
GEMINI_API_KEY=
NODEMAILER_SENDER_EMAIL=
SENDER_PASSWORD=

Running the Project

npm run dev

🤝 Contribution Guide

I hearty welcome contributions! Please follow these steps:

  • Fork the repository.
  • Create a new branch (git checkout -b feature-branch-name).
  • Make your changes and commit them (git commit -m "Add feature description").
  • Push your changes (git push origin feature-branch-name). Create a Pull Request.

Thank you for checking out this project! Feel free to open an issue if you have any questions or suggestions.

About

receive messages from anyone anonymously

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published