https://github.com/codingshot/linktree-bos
https://github.com/codingshot/linktree-bos
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/codingshot/linktree-bos
- Owner: codingshot
- License: unlicense
- Created: 2023-08-08T12:29:38.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-10T12:14:40.000Z (over 1 year ago)
- Last Synced: 2025-03-29T10:11:30.801Z (about 2 months ago)
- Language: TypeScript
- Homepage: https://linktree-bos.vercel.app
- Size: 3.6 MB
- Stars: 1
- Watchers: 2
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BOS Linktree
Easily deploy a linktree of your profile on the SocialDB (bos) - updates when you add information from any gateway
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fcodingshot%2Flinktree-bos&build-command=pnpm%20run%20build&env=NEXT_PUBLIC_NETWORK_ID,NEXT_PUBLIC_HOSTNAME,NEXT_PUBLIC_ACCOUNT_ID,NEXT_PUBLIC_THEME&envDescription=mainnet-near.org-themecanbeanything&envLink=https%3A%2F%2Fgithub.com%2Fcodingshot%2Flinktree-bos%2Fblob%2Fmain%2F.env.example)
Video Tutorial
https://www.youtube.com/watch?v=a8ULNp1q2uQ&t=1s
To setup a custom domain on vercel
https://vercel.com/docs/concepts/projects/domains/add-a-domain
# Available Themes
- default
- dark
- gold
- blossom
- vibrant
- aqua
- neon
- vintage
- eclectic
## Setup & Development
Initialize repo:
```bash
pnpm i
```
Start development version:
```bash
cp .env.example .env
pnpm dev
```
The entry component is ```LinktreeBOS``` and it's located at
```/src/components/polygon/index.tsx```
It loads the ```ndcplug.near/widget/Linktree.Main``` BOS component. The source can be found [here](https://near.org/near/widget/ComponentDetailsPage?src=ndcplug.near/widget/Linktree.Main&tab=source).
## Deployment
This is a [Next.js](https://github.com/vercel/next.js/) app and a fork of [NEAR Discovery](https://github.com/near/near-discovery) gateway app.
For static exports just run ```next build``` and upload the build files to your hosting provider. More info [here](https://nextjs.org/docs/pages/building-your-application/deploying/static-exports).
For Vercel, Cloudflare or others that supports a Next app just connect the repo and follow the deploy steps from the dashboards.
More info on Next.js deployments [here](https://nextjs.org/docs/pages/building-your-application/deploying/static-exports).
## Running with docker
```bash
docker build -t linktree-bos .
docker run -p 3000:3000 linktree-bos
```