Skip to content

Latest commit

 

History

History
113 lines (74 loc) · 1.87 KB

README.md

File metadata and controls

113 lines (74 loc) · 1.87 KB
Raw

Shorl - An app to manage your short links

A simple short link manager XD

💪 Features

  • ✅ Fast short link redirection
  • ✅ Different permissions for different users
  • ✅ Custom short link
  • ✅ Privacy options

🚀 Getting Started

Prerequisites

With Docker:

  • Docker
  • Docker Compose

Step 1

Clone the repository

git clone https://github.com/tobycm/l
cd l

Step 2

With web frontend:

docker compose -f docker-compose-full.yaml up

Without web frontend:

docker compose up

Without Docker:

Step 1

Clone the repository

git clone https://github.com/tobycm/l
cd l

Step 2

Install the dependencies

cd web
bun i
cd ..

cd server
bun i
cd ..

Step 3

Start services

cd pocketbase
pocketbase serve
cd web
bun run dev
cd server
bun run start

Disabling sign up (optional)

You can go to your PocketBase admin dashboard (https://<your pocketbase url>/_/) and set users collection create rule to admin only.

📚 Tech Stack

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🤝 Contributions

Any contribution is appreciated. Just create an issue/pull request and I will review it ASAP.

🔗 Share this project

If you like this project, please give it a ⭐ and share it with your friends!