Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hangerthem/linkboard

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.
https://github.com/hangerthem/linkboard

customizable easy-to-use links nextjs reactjs small-project styled-components

Last synced: 6 days ago
JSON representation

Host: GitHub
URL: https://github.com/hangerthem/linkboard
Owner: HangerThem
License: agpl-3.0
Created: 2023-10-19T11:06:57.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-08-28T05:05:34.000Z (3 months ago)
Last Synced: 2024-08-28T06:24:05.852Z (3 months ago)
Topics: customizable, easy-to-use, links, nextjs, reactjs, small-project, styled-components
Language: TypeScript
Homepage: https://socials.hangerthem.com
Size: 765 KB
Stars: 15
Watchers: 1
Forks: 3
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT

Awesome Lists containing this project

README

# LinkBoard

![GitHub Repo Size](https://img.shields.io/github/repo-size/hangerthem/linkboard)
![GitHub Issues](https://img.shields.io/github/issues/hangerthem/linkboard)
![GitHub Stars](https://img.shields.io/github/stars/hangerthem/linkboard)
![GitHub Forks](https://img.shields.io/github/forks/hangerthem/linkboard)

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:

```bash
git clone https://github.com/hangerthem/LinkBoard.git
cd LinkBoard
```

2. Install the necessary dependencies:

```bash
npm install
```

3. Start the development server:

```bash
npm run dev
```

4. 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](CONTRIBUTING).

## License

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

## Contact

- **Frank Borisjuk**
- Email: [[email protected]](mailto:[email protected])

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

_Happy LinkBoarding!_