Skip to content

chroline/lynk

Repository files navigation

lynk

Release last commit Maintainability License

open-source "link in bio" clone


🚀 Introduction

lynk is an open-source, self-hosted link-in-bio clone! With lynk, developers can easily set up their own custom link-in-bio page, allowing them to showcase their projects and promote their work in a single, easy to find location. lynk is fully customizable, allowing developers to tailor the look and feel of their page to their individual needs and preferences.

lynk is powered by:

  • MDX, for adding interactive content
  • Next.js, to enable SSG for lightning-fast load times
    • next-seo, to enrich your site with SEO
  • SCSS, for customizing the look of your site
  • Typescript, because it's 2023

Thanks for checking out the project, and happy coding!

🌟 Quickstart

Easy as 1, 2, 3!

  1. Fork the chroline/lynk template repo. This will give you a blank canvas for your lynk instance. (Or, use degit to scaffold your project by running degit chroline/lynk)

  2. Clone your forked repo to your local machine.

    git clone *YOUR_REPO*
  3. Customize your instance and add content.

...and then you're done!

Since lynk is built with JAMStack technologies, you can deploy your instance to your favorite serverless/static web host provider like Vercel or Netlify.

📖 Documentation

In-depth documentation is coming soon! For now, check out the example in the template repo.

🧑‍💻 Contributing

Interested in contributing to the lynk project? Thanks so much for your interest! We are always looking for improvements to the project and contributions from open-source developers are greatly appreciated.

❤️ Support this project

If you want to say thank you and/or support active development of lynk:

  • Add a GitHub Star to the project!
  • Tweet about the project on your Twitter!
  • Create your own lynk and share it with the interwebs!

Thanks so much for your interest in supporting lynk!

PS: consider sponsoring me (Cole Gawin) to continue the development of this project on BuyMeACoffee :)