Skip to content

YouAskWeBuild/MyLinx

Repository files navigation

MyLinx

A simple bio links tool for developers

Travis (.com) Maintenance OSS Lifecycle GitHub contributors GitHub language count GitHub top language GitHub issues GitHub closed issues GitHub pull requests GitHub GitHub Repo stars GitHub forks Website Discord

MyLinx is an open source tool to create and host your bio links page in github.

Looking for a demo ?

MyLinx Demo

MyLinx Builder Demo

Features

  • Add unlimited links
  • Search and filter
  • Add Social media links
  • Customize your background
  • Highlight links
  • MyLinx Builder with live preview
  • Save & Load your data in builder

Built Using

MyLinx uses the following open source projects:

  • [TailwindCSS] - Website is built using TailwindCSS!

And of course MyLinx itself is open source with a Apache 2.0 license on GitHub.

Do you need one like the Demo for yourself ?

Here is what you should do

  • Fork the repository MyLinx

  • Go to Settings -> Pages -> Select gh-pages branch, /root in the next select folder and click on Save

    Example

  • Your own site ([your-github-profile-name].github.io/MyLinx) will be up soon.

  • You can either visit ([your-github-profile-name].github.io/MyLinx/builder.html) or visit MyLinx Builder to add your own links to display on Mylinx.

  • Once you are done, click on Copy Data button on the builder page. This will copy the links data to clipboard.

  • Now go to your repository and switch your branch to gh-pages

  • Edit or Create a new file named data.json and replace the content with the clipboard content that was copied.

  • That's it! Your website is now ready. You can add the link ([your-github-profile-name].github.io/MyLinx) now to your instragram bio or where ever you want.

  • In case you want to add or remove, you can click on Load Data button and paste the content of your data.json and begin editing from there.

Installation

To run locally

MyLinx requires Node.js v14+ to run.

Clone this repository

Install the dependencies and devDependencies and start the server.

cd MyLinx
npm install
npm run start:api
npm run start:client

For production environments...

npm install
npm run build

Plugins

MyLinx is currently extended with the following plugins.

Plugin Usage
Tailwind Forms Forms in MyLinx builder are built using tailwind forms plugin

Contribute

Want to contribute? Great!

Join our discord server

Let us know what feature you want to work on, then proceed.

Fork the repository MyLinx

Clone your forked repository

Make the changes to your clone and provide a PR!

License

Apache 2.0

Free Software, Hell Yeah!

tailwindcss tailwind forms sortable.js

Authors

Balachandar Sureshkumar