Documentation

Here you should find everything you need from getting started with creating your Profile to more advanced topics. We welcome contributions, check out the LinkFree repo and the documentation source on GitHub for more information.

Getting started

This is the best way to get started building your Profile

Beginner

Quickstart

There are 4 ways you can add your profile, but for this Quickstart we will use the GitHub UI.

Beginner

GitHub UI

This is a great way to get started, you do not need to install anything, you can do it directly in the browser on GitHub.

Beginner

Gitpod

When you want to make more advanced changes, you will need to have a development environment. Gitpod runs VSCode and a whole environment in your browser.

Intermediate

Local development

This allows you the most customisation to your development environment, but requires more setup time.

Intermediate

Docker Compose

This might sound scary but it is actually the easiest solution for a local development environment.

Intermediate

LinkFree CLI

This CLI tool will allow you to create profile, update profile, add testimonials and more from the command line.

Beginner

Available icons

Search for available icons you can use on your profile.

Beginner

Environment variables

To run the application you need to have environment variables set for the application to work correctly.

Customising your Profile

More features to customise your Profile

Beginner

Editing

If you want to edit your profile (for example update a link or remove a link), follow these steps.

Beginner

Bio

The bio string in the json file is special! It allows for the use of Markdown. This will allow you to use the formatting styles like italic and bold.

Beginner

Links

Let people discover all your great content in one place by adding links to your social media account and other resources.

Beginner

Statistics

This will show the number of people who have viewed your Profile, as well as the number of people who have clicked on the links you have on your Profile.

Beginner

Tags

These are searchable keywords for people to discover your Profile. They can be your area of expertise, interests or tech you use (for example `DevRel` or `Javascript`).

Beginner

Social shortcuts

Add a shortcut to your favourite social media accounts at the top of your Profile.

Beginner

Milestones

Demonstrate the highlights of your career by adding Milestones to your Profile. This could be when you got your first job to reaching 100k followers/subscribers.

Beginner

Events

Hosting or attending events, let people know what you are up to by adding these events to your Profile.

Intermediate

Testimonials

Show off the great feedback you have received.

Contributing

You can contribute to our project in multiple ways

Beginner

Storybook

Run Storybook locally to see what React components are available to use.

Intermediate

Automated tests

Run the Playwright testing framework that drives the browser as a user does via code.

Beginner

Hacktoberfest

Contribute to this annual Open Source event with LinkFree.

Beginner

Commit Style

On EddieHub repos we use Conventional Commits standards. This allows us to create a changelog and release from the commits.

Beginner

Labels

We use labels to display various information about the issue, for example: is it ready for development or is it still waiting for the maintainers to review, the complexity of the issue and more.

Extra

More information

Beginner

Full Profile Example

See the json code for a full Profile with all the features enabled.

Advanced

Single user mode

Self host LinkFree for your single Profile.

Beginner

Map Information

Information describing how the map feature works.

Beginner

FAQs

Commonly asked questions and answers.