https://github.com/tiaansu/social-profiles
A simple app to share your social profiles! Made using Next.JS
https://github.com/tiaansu/social-profiles
Last synced: 3 months ago
JSON representation
A simple app to share your social profiles! Made using Next.JS
- Host: GitHub
- URL: https://github.com/tiaansu/social-profiles
- Owner: Tiaansu
- Created: 2023-12-02T11:15:42.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-05T09:54:08.000Z (over 1 year ago)
- Last Synced: 2025-01-06T06:43:38.680Z (5 months ago)
- Language: TypeScript
- Homepage: https://social-profiles.tiaansu.vercel.app
- Size: 214 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# social-profiles
_Special thanks to [@cnrad](https://github.com/cnrad/) for creating [this project](https://lanyard.cnrad.dev/), it's my inspiration for this project._
## Usage
First, go to this [website](https://social-profiles.tiaansu.vercel.app/) and login your google account.
You have two options to share your social profiles, first is by adding it in your `README.md` file and by adding it in your bio.
- For adding in your `README.md`, copy this and replace `:userId` with your userId (found on the [website](https://social-profiles.tiaansu.vercel.app/)).
```md
[](https://social-profiles.tiaansu.vercel.app/:id)
```
It should display something similar to the following:
[](https://github.com/Tiaansu)
- For adding in your bio, copy this and replace `:userId` with your userId (found on the [website](https://social-profiles.tiaansu.vercel.app/)).
```md
https://social-profiles.tiaansu.vercel.app/:userId
```
## Options
There are few options to customize this display using query parameters:
- Theme
- Append the query param `theme=:theme` to the end of the URL, replacing `:theme` with either `light` or `dark`. This will change the background and the font colors, but the background can be overridden with the __Background Color__ parameter.
- Background Color
- Append the query param `bg=:bg` to the end of the URL, replacing `:color` with a hex color of your choice ([omit](https://www.merriam-webster.com/dictionary/omit) the #)
- Border Radius
- Append the query param `borderRadius=:radius` to the end of the URL, replacing `:radius` with a radius of your choice. (default `10px`)
---
> [!NOTE]
> _If you're using this in your profile, feel free to show support and give [this repo](https://github.com/Tiaansu/social-profiles) a ⭐ star! It means a lot, thank you :)_
> If you also did like this project, consider sponsoring me (**long url is not that good, right?**)
> [!NOTE]
> _Contributing is open so if you want to change something or add something, you can do so._