fylsen/astrolinkhub

Open source links page, customizable via JSON. Made with Astro 4.

AstroLinkHub

Open source links page, customizable via JSON. Made with Astro 4.

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. JSON
   • Icons
4. Contributing
5. License

About The Project

For a while I was thinking about how popular link pages have become, both for companies and individuals. I've never liked the "free" solutions that many companies provide where they self-promote on every page you create.

That's exactly why I created AstroLinkHub! With this template you will be able to:

• Create your very own links page for FREE.
• Use the colors you want and give yourself all the credits for it.
• And most importantly, update it very easily using JSON.

Back to top ⬆️

Getting Started

Important

I'm glad to announce that this project is available on Astro Themes! 🚀

Prerequisites

• Node.js -> v18.17.1 or v20.3.0 or higher. (v19 is not supported)
• Visual Studio Code -> with the Official Astro Extension.

Personally I prefer using pnpm instead npm and to install it you can use:

npm install -g pnpm

Installation

1. Clone this repo to your computer:

   git clone [email protected]:MarcosKlender/AstroLinkHub.git

2. Install Astro dependencies:

   cd AstroLinkHub
   pnpm install

3. Run the Astro dev server:

   pnpm dev

Back to top ⬆️

JSON

The best part of AstroLinkHub is that you can modify every aspect of the website very easily, you just have to edit the index.json file. This JSON contains the following sections:

• html -> Edit language, title, description and favicon (replace it in /public).
• background -> Use the same color twice for a solid color or use two colors for a gradient color.
• header -> Edit your image (replace it in /public), name and description.
• socials -> Add more icons with your socials URL (see the networks available).
• featured -> Highlight links with a background image or color (same as buttons).
• buttons -> Add more buttons with your socials URL (see the networks available).
• footer -> Edit the copyright and URL of the developer (Made just for you 😎).

Icons

Just edit the key network with any of the following values (case-sensitive):

• Discord
• Facebook
• GitHub
• Instagram
• Link
• LinkedIn
• Mail
• Map
• Medium
• Spotify
• TikTok
• Twitch
• WhatsApp
• X
• YouTube

Note

If you need more open-source icons, visit: Tabler Icons

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 "feature". Don't forget to give the project a star! ⭐

Back to top ⬆️

License

Distributed under the MIT License. Open Source is pretty self-descriptive.

Back to top ⬆️