Skip to content

Latest commit

 

History

History
155 lines (90 loc) · 7.18 KB

README.md

File metadata and controls

155 lines (90 loc) · 7.18 KB
Raw

Open in GitPod Uptime License: MIT GitHub release (latest by date) GitHub repo size

What is LinkFree?

LinkFree is the Open Source alternative to LinkTree. A platform where people in tech can have a single hub to showcase their content in order to accelerate their career, whilst contributing to an Open Source project and being part of a community that has a say in where the project is going.

Your profile will have links to your social media and content. You can also add your timeline, testimonials, and upcoming events that you are participating in.

Here is an example of a LinkFree Profile https://linkfree.io/eddiejaoude

Example profile and statistics page on LinkFree with light and dark mode

Tech Stack

LinkFree was built using the following technologies:

  • Next.js - a framework for building server-rendered React applications
  • MongoDB - a NoSQL database
  • Tailwind CSS - a utility-first CSS framework

🛠️ Quickstart

You have 4 options to contribute to the repo, please pick your favourite from:

  1. GitHub UI (recommended for adding/editing your profile)
  2. Gitpod
  3. Local development
  4. Local development with Docker Compose

Brief documentation is below, but full documentation can be found here https://linkfree.io/docs

GitHub UI

This is great if you only want to add your Profile or make changes to it.

Here is the QuickStart guide to add your profile - https://linkfree.io/docs/quickstart

Note: give extra attention to JSON formatting and the GitHub Action after you create the Pull Request

Read more in the official documentation - https://linkfree.io/docs/environments/github-ui

Gitpod

In the cloud-free development environment which will have all the dependencies you need (for example MongoDB).

You can use Gitpod in the cloud Gitpod Ready-to-Code

Read more in the official documentation - https://linkfree.io/docs/environments/gitpod

Local development

This environment is fully on your computer and requires each dependency (for example MongoDB) to be installed and set up, but it gives you the most flexibility for customisation.

Prerequisites

Before contributing or adding a new feature, please make sure you have already installed the following tools:

  • NodeJs (Works with Node LTS version v16.17.0)
  • MongoDB
  • Optional NVM: Switch Node version by using nvm use (on Windows, use nvm use v16.17.0). If this is not installed, run nvm install v16.17.0.

Commands

You can set this up locally with the following steps:

  1. copy the .env.example file to .env and update any details required
  2. MongoDB is required, it is possible to use docker compose up to start the MongoDB service
  3. npm ci
  4. npm run dev

Read more in the official documentation https://linkfree.io/docs/environments/local-development

Local development with Docker Compose

This will allow you to run your favourite IDE but not have to install any dependencies on your computer like NodeJS and MongoDB.

Prerequisites

Commands

  1. docker compose up

Read more in the official documentation - https://linkfree.io/docs/environments/local-development-docker-compose

🙂 How to add YOUR Profile

Step by step quickstart guide can be found in the full docs here - https://linkfree.io/docs/quickstart

⛩️ Testimonials

Here are some testimonials from individuals who have used LinkFree:-

Francesco Ciulla

Francesco Ciulla

"I had another similar (paid) service. I tried LinkFree for a week and I got almost double the clicks on the links in the same period, redirecting from the same link. I decided to start using it regularly. I am very satisfied. It's not just a list of links but it's backed by a great Open Source community."

  • Name : Francesco Ciulla
  • Bio : Developer Advocate at daily.dev, Docker Captain, Public Speaker, Community Builder
  • Username : Francesco Ciulla

Amanda Martin

Amanda Martin

"Where LinkFree really stands out is the ability to make meaningful connections and find collaborators due to thoughtful features that are not simply about chasing ways to build your audience. The fact that it's also Open Source really makes it the tool I was waiting for in this space."

  • Name : Amanda Martin
  • Bio : Developer Advocate | Always Curious | Always Silly
  • Username : Amanda Martin

Pradumna Saraf

Pradumna Saraf

"LinkFree is very close to me because I have seen it evolve. With LinkFree, I have discovered so many amazing people in tech. Some of my favorite features are the barcode for profiles and testimonials. If you are reading this and don't have a profile, I highly recommend doing that. Thank you, Eddie and EddieHub community, for building this incredible app."

  • Name : Pradumna Saraf
  • Bio : Open Source Advocate | DevOps Engineer | EddieHub Ambassador
  • Username : Pradumna Saraf

🛡️ License

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

🧰 Contributing

  • Contributions make the open source community an amazing place to learn, inspire, and create.
  • Any contributions you make are truly appreciated.
  • Let's continue contributing to keep the community active and growing.

🙏 Support

Don't forget to leave a star ⭐️.