Blink is a URL shortener built with SvelteKit and PocketBase. It provides a clean and simple interface for shortening long URLs into short, memorable links.
- URL Shortening: Shorten long URLs using a custom or automatically generated slug.
- Customizable Slugs: Create your own short URLs.
- Click Tracking: Track the number of clicks on each shortened URL.
- Clean UI: Modern and user-friendly interface.
- Dark Mode: Toggle between light and dark themes.
- Keyboard Shortcuts: Efficient navigation and actions using keyboard shortcuts. (See the help dialog for details).
- Frontend: SvelteKit
- Backend: PocketBase (self-hosted)
- Styling: Tailwind CSS
- State Management: SvelteKit's Runes API for reactivity
- Package Manager: Bun
-
Clone the repository:
git clone <repository_url>
-
Install dependencies:
bun install
-
Start PocketBase (if not already running): This project uses a self-hosted PocketBase instance. You can start it using:
npm run pocketbase:dev # or the equivalent Bun command if available. Check your package.json. Or you can skip this step and check the step 5.(This command starts PocketBase in development mode on
http://localhost:8090. Adjust the port if necessary.) -
Generate PocketBase types:
bun run typegen
This will generate the types for the PocketBase collections and save them in the
typesfolder. -
Run the development server:
bun run start # this will start the SvelteKit app and the PocketBase server on different ports together. -
Visit:
http://localhost:5173 -
For admin access to PocketBase, visit:
http://localhost:8090/_/- Create an admin user.
- Now you will be able to see tables already created in the
collectionsfolder. - You can also create new collections from the UI.
Deployment instructions will be added later.
Contributions are welcome! Please open an issue or submit a pull request.
Copyright 2024 THISUX PRIVATE LIMITED
Licensed under the Affero General Public License (AGPL-3.0)