Skip to content

LinkBoard is a customizable web application that lets you create a personalized and visually appealing link board to share your important links and information with others, enhancing your online presence.

License

Notifications You must be signed in to change notification settings

HangerThem/linkboard

Repository files navigation

LinkBoard

GitHub Repo Size GitHub Issues GitHub Stars GitHub Forks

LinkBoard is a web application that allows you to create a personalized link board, similar to a bulletin board, to share your important links with others. It's a simple and customizable way to showcase your online presence.

Features

  • Customizable: Tailor your LinkBoard to your preferences with a variety of customization options.
  • Responsive: LinkBoard is designed to work seamlessly on all screen sizes and devices.
  • Beautiful Design: Enjoy an attractive and user-friendly design that enhances your online presence.
  • Easy to Use: Setting up and managing your LinkBoard is straightforward and hassle-free.

Installation

  1. Clone this repository:
git clone https://github.com/hangerthem/LinkBoard.git
cd LinkBoard
  1. Install the necessary dependencies:
npm install
  1. Start the development server:
npm run dev
  1. Visit http://localhost:3000 in your web browser to see your LinkBoard in action.

Usage

  1. Customize your LinkBoard by editing the configuration file config.ts to include your name, description, and social links.

  2. Customize the visual theme by modifying the theme.ts file. You can change the colors and fonts to suit your preferences. After that change the theme property in the config.ts file to your theme name.

  3. Add your profile picture by replacing the existing image at /public/profile.png.

  4. Add background image by replacing the existing image at /public/background.webp.

  5. Add links to your LinkBoard in the config.ts file. You can include the name, URL, and an optional icon.

  6. Customize the app's title in the config.ts file.

  7. Deploy your LinkBoard to a hosting service of your choice.

Additionally, there are some animations you can toggle in the config.ts file, also you can choose to sort the links by their lenght to make the board look more organized.

Contributing

I welcome contributions from the community. If you'd like to contribute to this project, please follow my Contribution Guidelines.

License

This project is licensed under the AGPLv3 License. For more information, please refer to the LICENSE file.

Contact

Feel free to reach out if you have any questions, suggestions, or need assistance.

Happy LinkBoarding!

About

LinkBoard is a customizable web application that lets you create a personalized and visually appealing link board to share your important links and information with others, enhancing your online presence.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Sponsor this project

Packages