Skip to content

Latest commit

 

History

History
66 lines (43 loc) · 2.34 KB

README.md

File metadata and controls

66 lines (43 loc) · 2.34 KB

Linkees Experimental Branch 🔬💻

⚠️ Warning

This branch of Linkees is for experimental purposes only and is not intended for production use. Most of the components in this branch are broken and may not function as expected.

 Linkees

Generic badge Twitter URL

About 🎯

A beautiful Single Page Web App made with React to display all your important social links for your followers (Alternative to linktr.ee).

Screenshot

How to use ?🤔

install the linkees package

npm install --save linkees

import Linkees component from linkees package in your react app

import Linkees, { CHANNEL_TYPES } from "linkees";

Create a config for your links

[
  {
    title: //title of the link card
    subtitle: //subtitle of the link card
    link: //URL
    type: //channel type
  }
]

Example can be found in example-linktree/src/index.tsx

Deploy to Vercel or any other platform and Enjoy!



Deploy with Vercel

We also support Docker 🐳 .For more details read this.

Contributing 📝

We always welcome contributions; big or small, it can be documentation updates, adding new checks or something bigger. Please check the Contributing Guide for details on how to help out.

Special Thanks to those People who have contributed :