Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bitesinbyte/links
Simple and easy to use links organiser for your social media accounts
https://github.com/bitesinbyte/links
Last synced: 2 months ago
JSON representation
Simple and easy to use links organiser for your social media accounts
- Host: GitHub
- URL: https://github.com/bitesinbyte/links
- Owner: bitesinbyte
- License: mit
- Created: 2023-12-30T05:42:18.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-27T04:27:20.000Z (7 months ago)
- Last Synced: 2024-06-27T05:58:08.189Z (7 months ago)
- Language: TypeScript
- Homepage: https://links.bitesinbyte.com/
- Size: 1.65 MB
- Stars: 1
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
![CodeQL](https://github.com/bitesinbyte/links/actions/workflows/codeql.yml/badge.svg?branch=main)
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/bitesinbyte/links/badge)](https://securityscorecards.dev/viewer/?uri=github.com/bitesinbyte/links)# Links
Simple and easy to use links organiser for your social media accounts
Demo - https://bitesinbyte.github.io/links
## Configuration
There are two configuraiton file
1. [`config.json`](https://github.com/bitesinbyte/links/blob/main/data/config.json)
```json
{
"mainImageSource": "Main Image Path",
"mainImageAlt": "Main Image Alt",
"brandName": "Brand Name",
"description": "A short description",
"socialLinks": {
"instagram": "instagram link",
"linkedin": "",
"blog": "",
"web": "",
"github": "",
"facebook": "",
"snapchat": "",
"tiktok": "",
"twitter": "",
"youtube": ""
}
}
```2. [`links.json`](https://github.com/bitesinbyte/links/blob/main/data/links.json)
```json
{
"blog": [
{
"title": "Medium",
"link": "link"
},
{
"title": "Bites in byte - Blog",
"link": "link"
}
],
"instagram": [],
"linkedin": [],
"web": [],
"github": [],
"facebook": [],
"snapchat": [],
"tiktok": [],
"twitter": [],
"youtube": [],
"other": []
}
```## Technologies Used
- [Next.js 14](https://nextjs.org/docs/getting-started)
- [NextUI v2](https://nextui.org/)
- [Tailwind CSS](https://tailwindcss.com/)
- [Tailwind Variants](https://tailwind-variants.org)
- [TypeScript](https://www.typescriptlang.org/)
- [next-themes](https://github.com/pacocoursey/next-themes)## How to Use
### Use the template with create-next-app
clone the repository, run the following command:
```bash
git clone https://github.com/bitesinbyte/links.git
```### Install dependencies
```bash
npm install
```### Run the development server
```bash
npm run dev
```## License
Licensed under the [MIT license](https://github.com/bitesinbyte/links/blob/main/LICENSE).