Skip to content

PeekLink is a tool designed to instantly generate social previews of websites. You can make every shared link count across the web

Notifications You must be signed in to change notification settings

Khalil-codes/peek-link

Repository files navigation

PeekLink

PeekLink is your website’s social preview checker, instantly showing how your site will appear across various social platforms. Make every link shine and watch the clicks roll in!

Social Preview

A social preview is like a "first impression" for your website when you share a link on social media. It’s that little snapshot with an image, title, and description that pops up, trying to say, “Hey, click me, I’m interesting!”

Features

  • Users can enter a URL to generate it's social previews.
  • Support for displaying previews for Google, Twitter/X, WhatsApp, Facebook, Linkedin and many more.

Technical Details

  • Built with Next.js, React, and TypeScript
  • Uses Zod for schema validation and React Hook Form for form handling
  • Tailwind CSS for styling
  • Cheerio for web scraping to extract meta data from a website

Getting Started

To run the application, follow these steps:

  1. Clone the repository: git clone https://github.com/your-username/link-preview.git
  2. Install dependencies: npm install or yarn install
  3. Start the development server: npm run dev or yarn dev

Contributing

Contributions are welcome! If you find any issues or want to add new features, please open a pull request.

License

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

About

PeekLink is a tool designed to instantly generate social previews of websites. You can make every shared link count across the web

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published