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.

Example using Gitpod, ephemeral dev environment in the cloud (free)

👨‍💻 Demo

Check out the website: LinkFree

👇 Prerequisites

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

• Git
• NodeJs

🛠️ Installation Steps

1. Fork the project
2. Clone the project
3. Navigate to the project directory cd LinkFree
4. Install dependencies with npm install
5. Run npm start
6. Optional: Run the tests with npm run cypress:run

Warning: After adding your profile, you'll not see it on the home page; you can see your profile in the main menu by running the command npm run generate.

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:

• Eddie Jaoude
• nhcarrigan
• Kaiwalya Koparkar

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"
    }
  ]
}

Your URL will be http://linkfree.eddiehub.org/<yourusername>

For example: http://linkfree.eddiehub.org/eddiejaoude

To include your avatar, You just have to replace <yourusername> with your github username in the format of https://github.com/<yourusername>.png and it will automatically be fetched from github account.

For example: http://github.com/eddiejaoude.png

Available Icons:

Socials	Icons	Socials	Icons	Socials	Icons
Android		Microsoft		Apple
PayPal		Discord		Slack
Envelope		Telegram		Facebook
Twitter		GitHub		Vimeo
Globe		YouTube		Link
Book		Dollar		Instagram
LinkedIn		Twitch		DEV.to
Hashnode		Codewars		Graduation Hat
TikTok		Send		Search
Left Arrow		Snapchat		Codeforces
Medium		Polywork

🛡️ License

LinkFree is licensed under the MIT License - see the LICENSE file for details.

💪 Thanks to all Contributors

Thanks a lot for spending your time helping LinkFree grow. Thanks a lot! Keep rocking 🍻

🙏 Support

This project needs a ⭐️ from you. Don't forget to leave a star ⭐️