Git Product home page Git Product logo

bb's Introduction

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


bb's People

Contributors

mohs27 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.