Merge pull request #4 from andreazorzi/development

v1.0.0

Author: andreazorzi

.env-example renamed to .env.example

@@ -13,4 +13,7 @@ DB_USERNAME=sail
 DB_PASSWORD=password
 
 ADMIN_USERNAME="admin"
-ADMIN_PASSWORD="password"
+ADMIN_PASSWORD="password"
+
+# Decomment for API
+# API_TOKEN=very_strong_token

.gitignore

@@ -17,4 +17,5 @@ yarn-error.log
 /.idea
 /.vscode
 composer.lock
-package-lock.json
+package-lock.json
+docker-compose.local.yml

Dockerfile

@@ -14,7 +14,8 @@ RUN dnf update -y \
        php-msgpack php-igbinary php-redis \
        php-memcached php-pcov php-xdebug -y \
     && dnf install supervisor -y
-RUN dnf install  php-swoole --nobest -y
+RUN dnf install php-swoole --nobest -y
+RUN dnf install mysql -y
 RUN mkdir -p /run/php-fpm/
 
 RUN curl https://getmic.ro | bash && mv micro /usr/bin/

README.md

@@ -1 +1,110 @@
-# PicoLink
+<p align="center">
+	<img src="https://github.com/andreazorzi/PicoLink/blob/development/public/images/logo.png?raw=true" alt="PicoLink" width="400"/>
+</p>
+<br>
+PicoLink is not the regular url shortner. It provide super power to your links.
+
+## ⚡️ Super Powers
+- Custom short link code, even with emojis: https://yoursite.com/🚀
+- Customized tags and advanced search to find your shorts faster 🔎
+- Quick sharing and qrcode creation 💻
+- Complete reports with visits by day, devices, referrers and countries 📊
+- Simple API for createating new shorts 🤖
+- Multilingual short link with automatic redirect based on client browser language 💥
+
+## 🛠️ How to install
+### 🐳 Docker File
+```yml
+services:
+    server:
+        container_name: "picolink-server"
+        image: ghcr.io/andreazorzi/picolink:latest
+        restart: unless-stopped
+        ports:
+            - '80:80'
+        environment:
+            APP_ENV: 'production'
+            APP_DEBUG: 'false'
+            APP_URL: 'https://yourdomain.com'
+            DB_DATABASE: 'laravel'
+            DB_USERNAME: 'picolink'
+            DB_PASSWORD: '_db_password_'
+            
+            ADMIN_USERNAME: 'admin'
+            ADMIN_PASSWORD: '_password_'
+        networks:
+            - sail
+        depends_on:
+            - mysql
+    mysql:
+        container_name: "picolink-db"
+        image: 'mysql/mysql-server:8.0'
+        restart: unless-stopped
+        environment:
+            MYSQL_ROOT_PASSWORD: '_root_password_'
+            MYSQL_ROOT_HOST: '%'
+            MYSQL_DATABASE: 'laravel'
+            MYSQL_USER: 'picolink'
+            MYSQL_PASSWORD: '_db_password_'
+        volumes:
+            - 'pathtodocker/picolink/mysql:/var/lib/mysql'
+        networks:
+            - sail
+networks:
+    sail:
+        driver: bridge
+```
+
+
+### 🎁 Additional .env configurations
+```yml
+# API Token
+API_TOKEN: _api_token_
+
+# Authentik
+AUTHENTIK_BASE_URL: "https://auth.host.com"
+AUTHENTIK_CLIENT_ID: ""
+AUTHENTIK_CLIENT_SECRET: ""
+AUTHENTIK_REDIRECT_URI: "/auth/authentik/callback"
+AUTHENTIK_SLUG: "picolink"
+```
+
+### 🤖 API Endpoint
+```json
+// Create multiple shorts
+// PUT /api/short/create
+// -H Authorization: Bearer _api_token_
+
+// Data
+{
+    "shorts": [
+        {
+            "code": "short1", // set null for generated code
+            "description": "link to website",
+            "url": "https://website.com/default-redirect-url",
+            "languages": [
+                {
+                    "language": "it",
+                    "url": "https://website.com/italian-redirect-url"
+                },
+                {
+                    "language": "de",
+                    "url": "https://website.com/german-redirect-url"
+                },
+                ...
+            ],
+            "tags": ["Tag1", "Tag2", "Tag3"]
+        },
+        ...
+    ]
+}
+
+// JSON Response
+{
+    "status": "success", // or danger
+    "message": "Short links created successfully.", // or the errors
+    "shorts": [ // if success, get the shorted link
+        "https://website.com/default-redirect-url": "https://short.com/short1"
+    ]
+}
+```

app/Classes/Help.php

@@ -4,7 +4,7 @@
 namespace App\Classes;
 
 use Illuminate\Support\Str;
-
+use Detection\MobileDetect;
 
 class Help
 {
@@ -13,7 +13,7 @@ public static function convert_date(string $date):string{
 	}
 
     public static function fragment(string $view, string $fragment, array $data = []):string{
-        return view($view, $data)->fragment($fragment);
+        return view($view, array_merge($data, ["fragment" => true]))->fragment($fragment);
 	}
 
     public static function strToLen(?string $str, int $len, bool $left = false){
@@ -45,4 +45,35 @@ public static function empty_dictionary($dictionary){
 
         return true;
     }
+    
+    public static function preferred_language(){
+        $browser_language = request()->getPreferredLanguage();
+        
+        return explode("_", $browser_language)[0];
+    }
+    
+    public static function getRequestData(){
+        // Browser language
+        $browser_language = explode("_", request()->getPreferredLanguage())[0];
+        
+        // Device type
+        $detect = new MobileDetect;
+        $device_type = "desktop";
+        
+        if($detect->isMobile()){
+            $device_type = $detect->isTablet() ? "tablet" : "mobile";
+        }
+        
+        // Referrer
+        $referrer = request()->headers->get("referer");
+        
+        $request_data = [
+            "ip" => config('app.env') == 'local' ? fake()->ipv4() : $_SERVER["HTTP_X_FORWARDED_FOR"] ?? request()->ip(),
+            "language" => $browser_language,
+            "device_type" => $device_type,
+            "referrer" => $referrer ? parse_url($referrer, PHP_URL_HOST) : "direct"
+        ];
+        
+        return $request_data;
+    }
 }