2021-08-14 13:39:53 +00:00
|
|
|
<p align="center">
|
2021-08-17 18:15:53 +00:00
|
|
|
<img height="150" src="./src/icon_128.png">
|
2021-08-14 13:39:53 +00:00
|
|
|
<h1 align="center">LinkyLinky 4 Chrome</h1>
|
|
|
|
|
<h3 align="center">A simple, privacy focused urls shortner</h3>
|
|
|
|
|
</p>
|
|
|
|
|
|
2021-08-21 18:59:48 +00:00
|
|
|
## 👀 Preview
|
|
|
|
|
<img height="300" src="./docs/fullpage_opened.webp">
|
|
|
|
|
<img height="300" src="./docs/fullpage_created.webp">
|
|
|
|
|
<img height="150" src="./docs/extension_opened.webp">
|
|
|
|
|
<img height="150" src="./docs/extension_created.webp">
|
|
|
|
|
<img height="400" src="./docs/fullpage_copy.webp">
|
2021-08-14 13:39:53 +00:00
|
|
|
|
|
|
|
|
## ⚡ Installation
|
2021-08-17 18:56:06 +00:00
|
|
|
- Download the `linkylinky-chrome.zip` from [the lastest release](https://git.odit.services/kauft.es/linkylinky-chrome/releases)
|
|
|
|
|
- Unzip the file
|
2021-08-14 13:39:53 +00:00
|
|
|
- Go to [Chrome Extensions](chrome://extensions/) (`chrome://extensions/`)
|
|
|
|
|
- Turn on `Developer Options` in the top right
|
|
|
|
|
- Click on `Load Unpacked` in the top left
|
2021-08-17 18:56:06 +00:00
|
|
|
- Select the unziped folder ("linkylinky-chrome")
|
2021-08-14 13:39:53 +00:00
|
|
|
|
2021-08-17 19:06:44 +00:00
|
|
|
## 🛠 Dev Setup
|
|
|
|
|
> Runs on port 3000
|
|
|
|
|
|
|
|
|
|
#### Yarn
|
|
|
|
|
```bash
|
|
|
|
|
yarn
|
|
|
|
|
yarn dev
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
#### NPM
|
|
|
|
|
```bash
|
|
|
|
|
npm i
|
|
|
|
|
npm run dev
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## 🚢 Build
|
|
|
|
|
#### Yarn
|
|
|
|
|
```bash
|
|
|
|
|
yarn
|
|
|
|
|
yarn build
|
|
|
|
|
# Optional to create the zip
|
|
|
|
|
yarn build:package
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
#### NPM
|
|
|
|
|
```bash
|
|
|
|
|
npm i
|
|
|
|
|
npm run build
|
|
|
|
|
# Optional to create the zip
|
|
|
|
|
npm run build:package
|
|
|
|
|
```
|
|
|
|
|
|
2021-08-14 13:39:53 +00:00
|
|
|
## 🏴 Roadmap/ Progress
|
|
|
|
|
- [x] Basic README
|
|
|
|
|
- [x] Publish to git
|
|
|
|
|
- [x] Basic functionality
|
|
|
|
|
- [x] Create generated urls
|
|
|
|
|
- [x] Create custom urls
|
|
|
|
|
- [x] Copy shorturl to deskop
|
|
|
|
|
- [x] Notify on copy
|
|
|
|
|
- [x] Generate another url
|
2021-09-25 16:51:23 +00:00
|
|
|
- [x] Disable bot crawling/chat preview on demand
|
|
|
|
|
- [x] Use clientside redirect w/ animation
|
2021-08-17 19:07:19 +00:00
|
|
|
- [x] Provide different url
|
2021-09-25 16:51:23 +00:00
|
|
|
- [x] Project Logo™
|
2021-08-17 17:47:28 +00:00
|
|
|
- [x] Basic error handling
|
|
|
|
|
- [x] Finalize styling
|
2021-08-17 19:06:44 +00:00
|
|
|
- [x] Advanced project stuff
|
|
|
|
|
- [x] Purge delivered css
|
|
|
|
|
- [x] Build script
|
|
|
|
|
- [x] Automagic builds via drone
|
|
|
|
|
- [x] Delivery as zip
|
2021-08-14 13:58:51 +00:00
|
|
|
|
|
|
|
|
## Credits
|
|
|
|
|
* ClipboardJS by Zeno Rocha licensed under MIT - Website: https://clipboardjs.com/ - Repo: https://github.com/zenorocha/clipboard.js
|
|
|
|
|
* TailwindCSS by TailwindLabs licensed under MIT - Website: https://tailwindcss.com - Repo: https://github.com/tailwindlabs/tailwindcss
|
|
|
|
|
* LinkyLinky Server: https://git.odit.services/kauft.es/linkylinky
|
