Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ajshovon/dash
DASH (Distributed Address Shortening Hub) is a decentralized application designed to shorten URLs. It leverages Cloudflare network to ensure fast and reliable short links.
https://github.com/ajshovon/dash
cloudflare cloudflare-pages cloudflare-workers drizzle-orm hono link-shortener neondb nextjs self-hosted
Last synced: 8 days ago
JSON representation
DASH (Distributed Address Shortening Hub) is a decentralized application designed to shorten URLs. It leverages Cloudflare network to ensure fast and reliable short links.
- Host: GitHub
- URL: https://github.com/ajshovon/dash
- Owner: ajshovon
- License: gpl-3.0
- Created: 2024-11-21T16:39:04.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-12-04T08:11:12.000Z (about 2 months ago)
- Last Synced: 2024-12-04T08:31:19.601Z (about 2 months ago)
- Topics: cloudflare, cloudflare-pages, cloudflare-workers, drizzle-orm, hono, link-shortener, neondb, nextjs, self-hosted
- Language: TypeScript
- Homepage: https://dash.shovon.me
- Size: 3.18 MB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# DASH
## Distributed Address Shortening Hub
## [Live Dashboard Demo ⚡](https://dash-demo.shovon.me/login)
Username: `admin`
Password: `admin`
> NB: Performing post, put, delete methods in the demo will not reflect in the database.
## Overview
DASH - Distributed Address Shortening Hub is a decentralized application designed to shorten URLs. It leverages Cloudflare network to ensure fast and reliable short links.
## Features
- **Decentralized**: Utilizes cloudflare and it's vast network for fast serving.
- **Secure**: Self hosted, so you manage your data.
- **User-Friendly**: Simple and intuitive interface for easy URL shortening.
## Deploy
### Requirements
1. Login to cloudflare, create a worker project named `dash-api` and create another pages project named `dash-web`
2. Generate a Cloudflare api token following this link:
3. Create a KV in cloudflare and copy the id. Follow this for more info:
4. Crate an account on NeonDB and get the connection string. Follow this guide if needed:
5. Create a JWT secret from here (length 32): or run this in terminal `node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"`
### Deploy With GitHub Actions
1. Create a new repo using this template
2. Goto the repo Settings -> Secrets and variables -> Actions. On Repository secrets section add these secrets
| Name | Value | Requirement |
| -------------------- | ---------------------------------------- | ----------- |
| CLOUDFLARE_API_TOKEN | Token generated from requirements step 2 | Required |
| CLOUDFLARE_KV_ID | KV ID from requirements step 3 | Required |
| NEON_DATABASE_URL | DB URL string from requirements step 4 | Required |
| JWT_SECRET | JWT secret from requirements step 5 | Required |
| DEFAULT_USER | Default username for login | Required |
| DEFAULT_PASSWORD | Default password for login | Required |
| API_CUSTOM_DOMAIN | Custom domain for the short link | Optional |
3. Goto the `Actions` tab on the repo, select `Deploy API and Web` action, select `Run workflow`, branch main, `Run workflow`
### Manual Deployment
1. Clone this repo locally and run `pnpm install`
2. Open `apps/api/wrangler.toml`, replace the `{{KV_ID}}` from with KV ID from requirements step 3. If you are going to use a custom domain for the short link, uncomment line 4 and replace `{{CUSTOM_DOMAIN}}` with your custom domain.
3. Create a `.env` file in `apps/api/` and fill in NEON_DATABASE_URL, DEFAULT_USER and DEFAULT_PASSWORD
4. Put the Neon database string on worker secret using: `pnpm db:set`
5. Put the JWT secret on worker using: `pnpm jwt:secret:set`
6. Run `pnpm worker:deploy:api` to deploy the api
7. Create a `.env` file in `apps/web/` and fill in NEXT_PUBLIC_WORKER with the custom domain or the worker url got from previous command
8. Run `pnpm pages:deploy:web` to deploy the web client
### Contributing
We welcome contributions! Please follow these steps:
1. Fork the repository.
2. Create a new branch:
```sh
git checkout -b feature-branch
```
3. Make your changes and commit them:
```sh
git commit -m "Description of changes"
```
4. Push to the branch:
```sh
git push origin feature-branch
```
5. Create a pull request.
### License
This project is licensed under the GPL 3.0 License. See the [COPYING](COPYING) file for details.
### Contact
For any questions or feedback, please open an issue