Skip to content
/ biolnk Public

Combine all your online content into one short, easy Biolink. You can also create Biolink pages for things like blogs, merch, multimedia and so much more.

License

Notifications You must be signed in to change notification settings

Kerosz/biolnk

Repository files navigation

Biolnk branding
Biolnk

Combine all your online content into one short, easy Biolink

AboutRoadmapContributingFeedbackLicense

Quick links

About The Project

The digital world and social media is dictating our lives nowadays, we need means to promote and advertise ourselves and our work.

Biolnk lets you create beautiful pages filled with links to all your online content with just a few taps. Customize your biolink page to fit your brand with your logo, the right colors, background image and much more. You get one link you can share anywhere, on platforms like Instagram or TikTok that only allow for one link.

NOTE: Biolnk came together as a fun project to try out new tech out there.

Key Features

  • Link management
    • Add/remove and reorder your links
    • Preview mode to only show the links you want
  • Page customization
    • Chose the style that fits you from multiple themes
    • Add a personal description about you or your brand
    • Chose your brand identity
    • Add your own SEO title & description for best results
    • Add your own custom domain or have a custom sub-domain provided by us
  • Page and link analytics
    • Track your overall page views
    • Track the performance of your links

Built With

The entire codebase consists in JavaScript/TypeScript, here is a list of technologies used:

Directory Structure

There is also a diagram that shows the repository architecture & indexing, you can check out the file here

biolnk/
├──apps — web/mobile applications
├────studio — app dashboard
├────web — web app, used for page generation
├──packages — internal libs
├────cli — tool used for codegen
├────core — shared module across packs and apps
└────gamut — internal UI component lib

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Any contributions you make are greatly appreciated. There are many ways in which you can participate in this project, for example:

If you are interested in fixing issues and contributing directly to the code base, see the below section on how to get started.

Getting Started

Prerequisites

We require you to use volta to manage your npm and node environment versions and pnpm to install dependencies

Installation

  1. Fork the project
  2. Clone the repo
  3. Install PNPM packages
    pnpm i
  4. Build packages
    pnpm build
  5. Run development server
    pnpm dev

Branching & PRs

  1. Create your Feature Branch (git checkout -b feat/some-amazing-feature)
  2. Commit your Changes (git commit -m "feat: add some amazing feature")
  3. Push to the Branch (git push -u origin feat/some-amazing-feature)
  4. Open a Pull Request

We require all new PRs to follow these guidelines. Any PR should use git keywords

<description> [Detailed description of the PR, it can be used the initial issue description]

Resolves #<issue_number>

Feedback

License

Licensed under the BSD-3-Clause license. See BSD-3-Clause for more information.

Acknowledgements


About

Combine all your online content into one short, easy Biolink. You can also create Biolink pages for things like blogs, merch, multimedia and so much more.

Topics

Resources

License

Stars

Watchers

Forks