/LinkFree

Open source alternative to LinkTree

Primary LanguageJavaScriptMIT LicenseMIT

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.eddiehub.io/eddiejaoude

Example profile on LinkFree

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.eddiehub.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.eddiehub.io/docs/quickstart

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

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

Local development

This environment is fully on computer and requires each dependency (for example MongoDB) to be installed and set up, but 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

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

🙂 How to add YOUR Profile

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

Looking for inspiration? You can view the following profiles for an example:

🛡️ 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 ⭐️