https://github.com/formkit/shorten
A public url shortener ❤️ 🌎 🗜️.
https://github.com/formkit/shorten
nitro public url-shortener
Last synced: 4 months ago
JSON representation
A public url shortener ❤️ 🌎 🗜️.
- Host: GitHub
- URL: https://github.com/formkit/shorten
- Owner: formkit
- License: mit
- Created: 2023-11-03T17:56:58.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-06T14:47:33.000Z (almost 2 years ago)
- Last Synced: 2025-06-05T19:08:44.482Z (4 months ago)
- Topics: nitro, public, url-shortener
- Language: TypeScript
- Homepage: https://formk.it
- Size: 41 KB
- Stars: 36
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# FormKit Url Shortener 🗜️
This is a public url shortener built with [UnJS’s excellent Nitro server](https://nitro.unjs.io/) server. Anyone is welcome to use it free of charge ❤️. You can use it to shorten any url, and in general we (the FormKit team) will try to keep these short url’s alive.
## Usage
To shorten a URL perform a post request to `https://formk.it` with the url you’d like to shorten in the body (this can be plain text or a JSON object with a "url" property):
```sh
curl -X POST -d "https://www.youtube.com/watch?v=10q09MMqU9E" https://www.formk.it
# https://formk.it/b4fa31ffi2xzf3fmv02czq0
```
## Your own shortener
You can of course run your own shortener, and we encourage you to do so.
```sh
npx giget@latest gh:formkit/shorten my-shortener-app
```
You’ll need to provide your own Nitro storage adapter credentials (we use Vercel’s KV store)
```ts
// nitro.config.ts
export default defineNitroConfig({
storage: {
kv: {
driver: "vercelKV", // 👀 your storage adapter
},
},
});
```
Finally use a `.env` file with the appropriate [environment variables for your adapter](https://unstorage.unjs.io/usage).
## Notice
If you chose to use the `formk.it` public shortener, please be aware that we cannot guarantee the longevity of the short urls. We will try to keep them alive, but we may need to remove them at any time. If you need a short url that will never change, please run your own shortener.