Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/velascoandres/pocket-link
application for link management featuring a convenient dashboard! This tool not only shortens links but also allows you to efficiently organize and monitor them through an intuitive dashboard
https://github.com/velascoandres/pocket-link
next-auth prisma t3-stack url url-shortener
Last synced: 3 days ago
JSON representation
application for link management featuring a convenient dashboard! This tool not only shortens links but also allows you to efficiently organize and monitor them through an intuitive dashboard
- Host: GitHub
- URL: https://github.com/velascoandres/pocket-link
- Owner: velascoandres
- Created: 2024-01-17T21:42:36.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-06-10T04:25:34.000Z (7 months ago)
- Last Synced: 2024-11-02T03:23:58.917Z (about 2 months ago)
- Topics: next-auth, prisma, t3-stack, url, url-shortener
- Language: TypeScript
- Homepage: https://pkin.vercel.app/
- Size: 766 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Pocket Link
Welcome to Pocket Link, your go-to application for link management featuring a convenient dashboard! This application is built using the [T3 stack](https://create.t3.gg/) with prisma.
Not only does it shorten links, but it also allows you to efficiently organize and monitor them through an intuitive dashboard. Transform lengthy links into concise, customized URLs that are effortlessly shareable. Take advantage of our dashboard to save, categorize, and track the performance of your links.
## How to Use
Clone this repository.
Set up your virtual environment (optional but recommended).
Copy the contents of `.env.example` into a new file named `.env` and configure the required variables.
```text
DATABASE_URL=""
NEXTAUTH_SECRET=""
NEXTAUTH_URL=""
DISCORD_CLIENT_ID=""
DISCORD_CLIENT_SECRET=""
GH_CLIENT_ID=""
GH_CLIENT_SECRET=""
GOOGLE_CLIENT_ID=""
GOOGLE_CLIENT_SECRET=""
```
Install dependencies.
```shell_script
yarn
```
If you need to build the databases locally, you can use the `docker-compose.yaml` file.
```shell_script
docker compose -D
```
> An instance of postgresql will be created
> This application uses vercel cronjobs
Setup the database.
```shell_script
yarn postinstall
yarn db:push
```
Run the application in dev mode
```shell_script
yarn dev
```
Open your browser and visit [http://localhost:3000](http://localhost:3000) to begin shortening URLs.
## Key Features
- **Quick Shortening:** Transform long links with just a few clicks.
- **Intuitive Dashboard:** Save, organize, and manage your links efficiently.
- **Customization:** Personalize shortened URLs according to your preferences.
- **Analytics:** Show analytics according of link interactions.
- **Not account required:** Create links without an account. But the links have a temporal duration.
We hope you enjoy using Pocket Link for all your link management needs! If you have any questions or issues, feel free to open an [issue](https://github.com/velascoandres/pocket-link/issues)