Skip to content

Latest commit

 

History

History
80 lines (52 loc) · 2.39 KB

README.md

File metadata and controls

80 lines (52 loc) · 2.39 KB
Raw

SilentNote

SilentNote is a fullstack application designed to allow users to send anonymous messages via a specific link. This application can be used for fun as well as for collecting multiple feedbacks. The project is built with a modern tech stack to ensure performance and scalability.

SilentNote Thumbnail

Live Demo

Check out the live version of the project here.

Tech Stack

  • Next.js: A React framework for server-rendered applications.
  • TypeScript: A statically typed superset of JavaScript.
  • NextAuth: Authentication for Next.js applications.
  • ShadCN: A UI library.
  • Framer: For Little Bit animation.
  • Prisma ORM: A next-generation ORM for Node.js and TypeScript.
  • PostgreSQL: A powerful, open source object-relational database system.

Features

  • Send anonymous messages through a specific link.
  • User-friendly interface built with Next.js and TypeScript.
  • Secure authentication with NextAuth.
  • Styled with ShadCN for a modern look and feel.
  • Smooth animations and interactions using Framer.
  • Efficient data management with Prisma ORM.
  • Robust and scalable database with PostgreSQL.

Installation

To get started with the project locally, follow these steps:

  1. Clone the repository:

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

  2. Install dependencies:

    npm install

  3. Set up environment variables: Create a .env file in the root directory and add the necessary environment variables. Refer to .env.example for the required variables.

  4. Run the development server:

    npm run dev

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

Usage

  1. Go to the live demo.
  2. Create a new link for anonymous messaging.
  3. Share the link with others.
  4. Receive anonymous messages through the link.

License

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

Contact

For any questions or feedback, feel free to reach out:

Thank you for checking out SilentNote!