LinkFree by EddieHub

LinkFree connects audiences to all of your content with just one link. It is an open-source alternative to Linktree implemented in JavaScript.
It was initially created on a YouTube live stream.

Note for Hacktoberfest

A note for Hacktoberfest participants:

Pull requests which add or edit your information in a public/data/${yourname}.json file will NOT be counted for Hacktoberfest.

Pull requests which improve the codebase, documentation, or other aspects of the project and are in line with the core values of the event will count. Maintainers will opt-in these PRs by applying the hacktoberfest-accepted label.

👨‍💻 Demo

Check out the website: LinkFree

👇 Prerequisites

Before installation, please make sure you have already installed following tools:

Git
NodeJs

🛠️ Installation Steps

Fork the project
Clone the project
Navigate to the project directory cd LinkFree
Install dependencies with npm install
Run npm start
Optional: Run the tests with npm run cypress:run

Alternatively, skip all the steps by using

👨‍💻 Contributing

Contributions make the open source community such an amazing place to learn, inspire, and create.
Any contributions you make are greatly appreciated.
Check out our contribution guidelines for more information.

🎭 To Add Your Profile

Create a file named your-username.json in the directory public/data.

Optional fields: links, milestones and type(personal | community)
Looking for inspiration? You can view the following profiles for an example:

Your brand new file should look something similar to this one:

{
  "name": "YOUR NAME",
  "type": "personal",
  "bio": "Open Source Enthusiast!",
  "avatar": "https://github.com/YOUR_GITHUB_USERNAME.png",
  "links": [
    {
      "name": "Follow me on GitHub",
      "url": "https://github.com/YOUR_GITHUB_USERNAME",
      "icon": "github"
    },
    {
      "name": "Follow me on Twitter",
      "url": "https://twitter.com/YOUR_TWITTER_USERNAME",
      "icon": "twitter"
    }
  ],
  "milestones": [
    {
      "title": "Started Freelancing",
      "date": "December 2021",
      "icon": "dollar",
      "color": "grey",
      "description": "Started freelancing",
    }
  ]
}