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
Quickstart
There are 4 ways you can add your profile, but for this Quickstart we will use the GitHub UI.
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.
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.
Local development
Set up the LinkFree codebase on your computer using either a pre-built Docker image or by installing all the dependencies for full control over your local dev environment.
LinkFree CLI
This CLI tool will allow you to create profile, update profile, add testimonials and more from the command line.
Available Icons
Search for available icons you can use on your profile.
Environment variables
To run the application you need to have environment variables set for the application to work correctly.
Community Resources
More information about Community resources and their collaborations.
MongoDB Atlas for Local Development
A step-by-step guide to setting up a MongoDB Atlas account and establishing a connection for local development.
Customising your Profile
More features to customise your Profile
Editing
If you want to edit your profile (for example update a link or remove a link), follow these steps.
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.
Links
Let people discover all your great content in one place by adding links to your social media account and other resources.
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.
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`).
Social Shortcuts
Add a shortcut to your favourite social media accounts at the top of your Profile.
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.
Events
Hosting or attending events, let people know what you are up to by adding these events to your Profile.
Testimonials
Show off the great feedback you have received.
Contributing
You can contribute to our project in multiple ways
Reviewers
Guidelines for reviewing Issues and Pull Requests
Storybook
Run Storybook locally to see what React components are available to use.
Automated Tests
Run the Playwright testing framework that drives the browser as a user does via code.
Hacktoberfest
Contribute to this annual Open Source event with LinkFree.
Commit Style
On EddieHub repos we use Conventional Commits standards. This allows us to create a changelog and release from the commits.
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 (with points) and more.
Docs Style Guide
A guide for contributors when making changes to the documentation.
Extra
More information
Profile Tips
Tips on making your LinkFree profile stand out.
Full Profile Example
See the json code for a full Profile with all the features enabled.
Single User Mode
Self host LinkFree for your single Profile.
Map Information
Information describing how the map feature works.
FAQs
Commonly asked questions and answers.
Maintainers
Maintainers guide to LinkFree.