Skip to content

Latest commit

 

History

History
78 lines (56 loc) · 2.46 KB

README.md

File metadata and controls

78 lines (56 loc) · 2.46 KB
Raw

NGL

NGL is a better clone of the popular anonymous messaging platform, built with Next.js. This project allows users to send anonymous messages to anyone, featuring robust validation, modern UI components, and a seamless database integration.

Features

  • Anonymous Messaging: Send and receive anonymous messages.
  • Zod Validation: Ensures robust and secure form validation.
  • Tailwind CSS: For fast and efficient styling.
  • ShadcnUI Integration: Provides a sleek and modern user interface.
  • MongoDB: A scalable and flexible database solution.

Tech Stack

  • Next.js: The React framework for production.
  • Tailwind CSS: A utility-first CSS framework for rapid UI development.
  • ShadcnUI: A modern UI component library.
  • Zod: TypeScript-first schema declaration and validation library.
  • MongoDB: NoSQL database for storing messages and user data.

Status

This product is not ready yet; I am currently building it. Stay tuned for updates!

Getting Started

Prerequisites

  • Node.js
  • MongoDB

Installation

  1. Clone the repository:

    git clone https://github.com/yourusername/ngl.git
cd ngl

  2. Install dependencies:

    npm install

  3. Set up environment variables: Create a .env.local file in the root directory and add your MongoDB connection string and any other necessary environment variables.

    MONGODB_URI=your_mongodb_connection_string

  4. Run the development server:

    npm run dev

    Open http://localhost:3000 with your browser to see the result.

Usage

  • Sending Messages: Users can send anonymous messages through a clean and intuitive interface.
  • Viewing Messages: Recipients can view messages in an organized manner.

Contributing

We welcome contributions! Please follow these steps:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature-branch).
  3. Commit your changes (git commit -m 'Add some feature').
  4. Push to the branch (git push origin feature-branch).
  5. Create a new Pull Request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

For any inquiries or feedback, please reach out to contact1dvlpr@gmail.com.

Feel free to customize the README with specific details about your implementation and any additional instructions or information relevant to your project.