Linkify

Linktree alternative with little to no code required!
View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

Hey there! Want a simple looking link management like Linktree/Milkshake but tired of it looking so bland? Look no further! Linkify is here to simplify your link management experience. It's packed with features to make your life easier.

Here's why Linkify rocks:

• Make your page look just the way you want with customizable themes, including a sleek dark mode, light mode, and premade theme (upcoming).
• No coding headaches here. Linkify gets you up and running in minutes, so you can focus on what matters.
• Free hosting using Vercel and add a personal touch with your own custom domain.
• Say goodbye to repetitive tasks. Linkify offers reusable components (buttons, cards, etc.) you can easily add whenever you want.

We're constantly improving on Linkify to meet your needs. Got any issues, ideas, or a feedback? We're all ears!

(back to top)

Built With

This project is built with the following tech-stack:

• 
• 
• 

For a full list of dependencies, see package.json.

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Installation

Below is the step-by-step guide on how to install and setup this project efficiently.

Setup

1. Clone the repo

   git clone https://github.com/msafdev/linkify.git

2. Install NPM packages

   npm install

3. Change the base color theme using Shadcn themes, then paste it to globals.css
4. Change to content of the page on content/content.ts

Development

1. Run the project

   npm run dev

2. Open your browser and go to http://localhost:PORT
3. Make changes to the content of the page on content/content.ts
4. Make changes to the theme by adding "dark" on the html of the page
5. Customize the code to your liking, and you're good to go!

Using the generator

1. Go to your http://localhost:PORT/generate
2. Add each link you want to add to your page on their respective forms
3. Click on the "Generate" button
4. Copy the content of generated object and paste it on content/content.ts

Deployment

1. Change the devMode.template on content/content.ts to false
2. Build the project or deploy it to Vercel (or any other hosting service actually)

(back to top)

Roadmap

• Add content.ts file generator
• Add theme switcher with session storage
• Add Changelog
• Add Additional Templates w/ Examples

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

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/feature-name)
3. Commit your Changes (git commit -m 'Add a feature-name')
4. Push to the Branch (git push origin feature/feature-name)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Your Name - Linkedin // faris.kocak@gmail.com

Project Link: https://github.com/msafdev/linkify

(back to top)

Acknowledgments

These are the resources that helped me build this project:

• Choose an Open Source License
• Img Shields
• Font Awesome
• Vercel
• React Icons

(back to top)