Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marcosklender/astrolinkhub
Open source links page, customizable via JSON. Made with Astro 4.
https://github.com/marcosklender/astrolinkhub
astro astrobuild json links linkspage linktree-alternative
Last synced: 2 months ago
JSON representation
Open source links page, customizable via JSON. Made with Astro 4.
- Host: GitHub
- URL: https://github.com/marcosklender/astrolinkhub
- Owner: MarcosKlender
- License: mit
- Created: 2024-06-24T04:52:56.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-07-13T20:51:32.000Z (6 months ago)
- Last Synced: 2024-07-13T21:49:27.034Z (6 months ago)
- Topics: astro, astrobuild, json, links, linkspage, linktree-alternative
- Language: Astro
- Homepage: https://astrolinkhub.netlify.app
- Size: 125 KB
- Stars: 5
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://astro.build/themes/details/astrolinkhub/)
AstroLinkHub
Open source links page, customizable via JSON. Made with Astro 4.
## Table of Contents
## 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.
## Getting Started
> [!IMPORTANT]
> I'm glad to announce that this project is available on [Astro Themes!](https://astro.build/themes/details/astrolinkhub/) 🚀
### Prerequisites
- **Node.js** -> `v18.17.1` or `v20.3.0` or higher. (`v19` is not supported)
- **Visual Studio Code** -> with the [Official Astro Extension](https://marketplace.visualstudio.com/items?itemName=astro-build.astro-vscode).
Personally I prefer using `pnpm` instead `npm` and to install it you can use:
```sh
npm install -g pnpm
```
### Installation
1. Clone this repo to your computer:
```sh
git clone [email protected]:MarcosKlender/AstroLinkHub.git
```
2. Install Astro dependencies:
```sh
cd AstroLinkHub
pnpm install
```
3. Run the Astro dev server:
```sh
pnpm dev
```
## 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](https://tabler.io/icons)
## 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!** ⭐
## License
Distributed under the MIT License. `Open Source` is pretty self-descriptive.