heysagnik / linkees

Awesome Linktree clone made with React ⚛️

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

About 🎯

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

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!

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 :

linkees's Issues

Dockerize Linkees

Hi @heysagnik, I believe there are developers out there would love to use Docker to run this application like me. I've managed to create two Dockerfiles - Development and Production as well as .dockerignore.

I tested the the Docker Images on both my local and my server and it works. I would love to contribute my work to this project.

Cheers!

Create this as an npm module

Are there any plans to make this available as an NPM module? It's so much quicker/easier/more normal to install via NPM/Yarn instead of having to fork and clone, you'd get way more downloads.

Add light mode 💡

open link in new tab

Dear, thats verry awesome,
is there a way to make the social links open in a new tab?

How can i install it?

How can i install it?

Put songs on the page

Is it possible to put songs on the page? with a song that immediately plays itself when first open the website

Error after clik deploy to vercel

After clicking the deploy button on your readme, it shown an error to deploy on vercel

[11:51:08.289] Running "vercel build"
[11:51:08.750] Vercel CLI 28.10.3
[11:51:09.331] Installing dependencies...
[11:51:10.542] npm ERR! code ERESOLVE
[11:51:10.544] npm ERR! ERESOLVE could not resolve
[11:51:10.544] npm ERR!
[11:51:10.544] npm ERR! While resolving: [email protected]
[11:51:10.544] npm ERR! Found: [email protected]
[11:51:10.545] npm ERR! node_modules/react
[11:51:10.545] npm ERR! react@"^17.0.2" from the root project
[11:51:10.545] npm ERR! peer react@"<18.0.0" from @testing-library/[email protected]
[11:51:10.545] npm ERR! node_modules/@testing-library/react
[11:51:10.545] npm ERR! @testing-library/react@"^12.1.2" from the root project
[11:51:10.545] npm ERR! 3 more (framer-motion, linkees, react-scripts)
[11:51:10.545] npm ERR!
[11:51:10.545] npm ERR! Could not resolve dependency:
[11:51:10.545] npm ERR! peer react@"^16.14.0" from [email protected]
[11:51:10.545] npm ERR! node_modules/react-dom
[11:51:10.545] npm ERR! react-dom@"^16.13.1" from the root project
[11:51:10.545] npm ERR! peer react-dom@"<18.0.0" from @testing-library/[email protected]
[11:51:10.546] npm ERR! node_modules/@testing-library/react
[11:51:10.546] npm ERR! @testing-library/react@"^12.1.2" from the root project
[11:51:10.546] npm ERR! 1 more (framer-motion)
[11:51:10.546] npm ERR!
[11:51:10.546] npm ERR! Conflicting peer dependency: [email protected]
[11:51:10.546] npm ERR! node_modules/react
[11:51:10.546] npm ERR! peer react@"^16.14.0" from [email protected]
[11:51:10.546] npm ERR! node_modules/react-dom
[11:51:10.546] npm ERR! react-dom@"^16.13.1" from the root project
[11:51:10.546] npm ERR! peer react-dom@"<18.0.0" from @testing-library/[email protected]
[11:51:10.546] npm ERR! node_modules/@testing-library/react
[11:51:10.546] npm ERR! @testing-library/react@"^12.1.2" from the root project
[11:51:10.546] npm ERR! 1 more (framer-motion)
[11:51:10.546] npm ERR!
[11:51:10.546] npm ERR! Fix the upstream dependency conflict, or retry
[11:51:10.547] npm ERR! this command with --force, or --legacy-peer-deps
[11:51:10.547] npm ERR! to accept an incorrect (and potentially broken) dependency resolution.
[11:51:10.547] npm ERR!
[11:51:10.547] npm ERR! See /vercel/.npm/eresolve-report.txt for a full report.
[11:51:10.547]
[11:51:10.547] npm ERR! A complete log of this run can be found in:
[11:51:10.547] npm ERR! /vercel/.npm/_logs/2023-01-10T04_51_09_555Z-debug-0.log
[11:51:10.562] Error: Command "npm install" exited with 1

Fix 🔧 the header

The logo part of header is weired fix it

Update the endpoint contract of linkees package

Describe the bug
Update the endpoint contract of linkees package and expose more components

Expected behavior
Currently, consumer of linkees package needs to use package as

import { Linktree } from 'linkees';

it should be

import Linkees from 'linkees';

Update `package/Linkees` readme

Describe the bug
Update package/Linkees readme

Expected behavior
This read-me file is shown on npm package page. (https://www.npmjs.com/package/linkees)

• How to use section needs to be updated
• Docker file description is no longer required

Setup Linkees

Can you add the whole setup? Because new coders can also know how to setup the project from the start to end.