Skip to content

An improved linktree example built with handlebars.js with easy customization on a single json.

License

Notifications You must be signed in to change notification settings

rinaldilucas/improved-linktree-example

Repository files navigation

Forks Stargazers MIT License LinkedIn


Logo

Improved Link Tree example

An awesome Linktree example to jumpstart
your studies or start your business.

Explore the docs »
Open · Donate

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. License
  6. Contact
  7. Donations

About The Project

Project Screenshot

There are many great linktrees examples available on Internet, however, I didn't find one that really suited my need, so I created this enhanced one using stacks that I wanted to practice. This is actually the sum of all my learning right now. If this project helped you in any way, don't hesitate to leave a star!

(back to top)

Built With

This section shows what technologies are used in this particular project.

(back to top)

Getting Started

After cloning the project, you need to do a few things to be able to run it.

Prerequisites

You need to have the following requirements:

  • node 14 (download here)

  • npm

      npm install -g npm
  • yarn

      npm install -g yarn
  • grunt cli

      npm install -g grunt-cli

Installation

Below is an example of how you can run the project.

  1. Clone the repo
    git clone https://github.com/rinaldilucas/improved-linktree-example.git
  2. Install the dependencies via yarn
    yarn install
  3. Build the project to develop
    grunt dev
  4. Build the dist folder
    grunt build --tiny-key={KEY}

(back to top)

Usage

To facilitate customization, I put some settings in the data.json file. Thus, you will be able to change the internal data of the site without having to code. Check CONFIG for more details.

For convenience, I put the data.json in the root of the project.

(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/amazing-feature)
  3. Commit your Changes (git commit -m 'feat: add some amazing feature')
  4. Push to the Branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

(back to top)

License

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

(back to top)

Contact

Website Github Gmail Badge Hotmail Badge Linkedin Badge Telegram Badge

Project Link: https://github.com/rinaldilucas/improved-linktree-example

(back to top)

Donations

If you feel that this project has helped you in any way, whether it's attracting clients or teaching you about the technologies used, feel free to make a donation. It helps me a lot to continue developing open source codes.

  • Metamask (USDT):
    0x16362DF7f963CeEBB2114B467B68F5A58972ee65
  • PIX (BRL):
    72140bc8-fadc-42f5-abb6-9c13cc80a59f

(back to top)