Welcome to Shotify, your easy-to-use URL shortener! Quickly shorten your long links with a single click, making them perfect for sharing on social media, emails, or anywhere you need a concise link. Try it now!
- Set up your own Pocketbase on your server or on PocketHost and sign in.
- Download the pb-schema.json file and open the settings in Pocketbase. Import the schema file.
- Clone this repository to your GitHub account.
- Navigate to the code in the
src/lib
folder and open pb.ts. Replace the URL with your own Pocketbase URL. - Deploy the repository on Vercel or your preferred hosting platform. Create a .env file with the user credentials you used to sign in to Pocketbase (refer to .env.example).
- After completing all the previous steps, you can deploy the URL shortener.
To run this project locally, follow these steps:
npm i pnpm -g
pnpm i
pnpm run dev
To build the project:
pnpm run build
- Make an account on Shortly and log in.
- Get your userID here
- To generate an API key, go to Profile Settings and click Generate API KEY.
curl --request POST \
--url https://shortly.bytebridge.tech/api/v1/create \
--header 'x_user: [Your_Username]' \
--header 'x_key: [Your_API_Key]' \
--header 'x_url: [Your_Url]'
curl --request DELETE \
--url https://shortly.bytebridge.tech/api/v1/delete \
--header 'x_user: [Your_Username]'\
--header 'x_key: [Your_API_Key]' \
--header 'x_id: [Your_Entry_Id]'
You will receive your entry ID when you create an entry.
curl --request GET \
--url https://shortly.bytebridge.tech/api/v1/getOne \
--header 'x_user: [Your_Username]' \
--header 'x_key: [Your_API_Key]' \
--header 'x_id: [Your_Entry_Id]'
curl --request GET \
--url https://shortly.bytebridge.tech/api/v1/getAll \
--header 'x_key: [Your_API_Key]' \
--header 'x_user: [Your_Username]'
curl --request PATCH \
--url https://shortly.bytebridge.tech/api/v1/update \
--header 'x_user: [Your_Username]'\
--header 'x_key: [Your_API_Key]' \
--header 'x_id: [Your_Entry_Id]' \
--header 'x_name: [Your_new_Entryname | not required]' \
--header 'x_url: [Your_new_url | not required]'
If you are self-hosting the platform, follow these steps using your own URL.
We welcome your suggestions! If you have any ideas, please feel free to create an issue. If you have any ideas, please do not hesitate to create a topic.
-
short urls ✔
-
Qr-codes ✔
-
add password requierd links ⭕
-
multi custome domain support ⭕
-
add meta tags ⭕