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.
This is the best way to get started building your Profile
There are 4 ways you can add your profile, but for this Quickstart we will use the 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.
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.
This allows you the most customisation to your development environment, but requires more setup time.
This might sound scary but it is actually the easiest solution for a local development environment.
This CLI tool will allow you to create profile, update profile, add testimonials and more from the command line.
Customising your Profile
More features to customise your Profile
If you want to edit your profile (for example update a link or remove a link), follow these steps.
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.
Let people discover all your great content in one place by adding links to your social media account and other resources.
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.
Add a shortcut to your favourite social media accounts at the top of your Profile.
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.
Hosting or attending events, let people know what you are up to by adding these events to your Profile.
You can contribute to our project in multiple ways
Run the Playwright testing framework that drives the browser as a user does via code.
On EddieHub repos we use Conventional Commits standards. This allows us to create a changelog and release from the commits.