Giter Club home page Giter Club logo

mylinx's Introduction

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

mylinx's People

Contributors

balachandarsv avatar dvrbnator avatar dependabot[bot] 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.