Feat: add production Docker Compose setup, LICENSE, and README docume… (#3)

* Feat: add production Docker Compose setup, LICENSE, and README documentation

* Fix: update footer link to point to the correct GitHub repository

* ~favicon

* Feat: enhance SEO and social sharing metadata in app.html

* Fix: update README to clarify project setup instructions

* Fix: update supervisord configuration for improved logging and process management

* Fix: remove JWT_SECRET from configuration loading

Author: kek-Sec

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2024] [Petrakis Georgios]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,53 @@
+# ✂️ **GoShort** - Fast and customizable URL shortener
+
+### Demo: [https://x.yup.gr](http://x.yup.gr)
+
+GoShort is a fast and customizable URL shortener built with Go , Svelte and TailwindCSS. It is designed to be self-hosted and easy to deploy.
+
+![GoShort](web/static/banner.png)
+
+---
+
+## 📋 **Table of Contents**
+
+1. [Features](#-features)  
+2. [Installation](#-installation)  
+3. [Contributing](#-contributing)
+4. [License](#-license)
+5. [Security](#-security)
+---
+
+## 🚀 **Features**
+
+- **Fast**: GoShort is built with Go and is blazing fast.
+- **Customizable**: GoShort is built with Svelte and TailwindCSS, making it easy to customize.
+- **Self-hosted**: You own your data and can deploy GoShort on your own server.
+- **Custom URLs**: You can set custom URLs for your short links.
+- **Expiration**: You can set expiration for your short links.
+
+---
+
+## 🛠️ **Installation**
+
+> Checkout docker-compose.prod.yml for a sample production setup.
+
+---
+
+## 🤝 **Contributing**
+
+1. Fork the repository.  
+2. Create a new branch: `git checkout -b my-feature-branch`  
+3. Make your changes and add tests.  
+4. Submit a pull request.  
+
+---
+
+## 📄 **License**
+
+GoShort is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.
+
+---
+
+## 🔒 **Security**
+
+We take security seriously and appreciate your efforts to responsibly disclose vulnerabilities. Checkout [SECURITY.md](SECURITY.md) for more information.

docker-compose.prod.yml

@@ -0,0 +1,34 @@
+services:
+  goshort-db:
+    image: postgres:17-alpine
+    container_name: goshort_db
+    environment:
+      POSTGRES_USER: goshort
+      POSTGRES_PASSWORD: goshort_password
+      POSTGRES_DB: goshort
+    volumes:
+      - ./postgres_data:/var/lib/postgresql/data
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U goshort -d goshort"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+    networks:
+      - goshort_net
+
+  goshort:
+    image: ghcr.io/kek-sec/goshort:1.0.1
+    container_name: goshort_app
+    environment:
+      DATABASE_URL: postgres://goshort:goshort_password@goshort-db:5432/goshort?sslmode=disable
+    depends_on:
+      goshort-db:
+        condition: service_healthy
+    ports:
+      - 8081:80
+    networks:
+      - goshort_net
+
+networks:
+  goshort_net:
+    external: true

pkg/config/config.go

@@ -17,7 +17,6 @@ func Load() {
 
 	configMap = map[string]string{
 		"DATABASE_URL": os.Getenv("DATABASE_URL"),
-		"JWT_SECRET":   os.Getenv("JWT_SECRET"),
 		"PORT":         os.Getenv("PORT"),
 	}
 }

supervisord.conf

@@ -1,27 +1,38 @@
 [supervisord]
 nodaemon=true
 user=root
-logfile=/tmp/supervisord.log
+logfile=/var/log/supervisord.log
 logfile_maxbytes=50MB
 logfile_backups=10
 loglevel=info
-pidfile=/tmp/supervisord.pid
+pidfile=/var/run/supervisord.pid
 identifier=supervisor
 
 [program:goshort]
 command=/app/goshort
+directory=/app
+environment=APP_ENV=production,APP_LOG_LEVEL=info
 autorestart=true
 startsecs=3
-stdout_logfile=/dev/stdout
-stderr_logfile=/dev/stderr
-stdout_logfile_maxbytes=0
-stderr_logfile_maxbytes=0
+stdout_logfile=/var/log/goshort_stdout.log
+stderr_logfile=/var/log/goshort_stderr.log
+stdout_logfile_maxbytes=10MB
+stderr_logfile_maxbytes=10MB
+stdout_logfile_backups=5
+stderr_logfile_backups=5
+user=nobody
+umask=022
+stopsignal=TERM
 
 [program:nginx]
 command=nginx -g "daemon off;"
 autorestart=true
 startsecs=3
-stdout_logfile=/dev/stdout
-stderr_logfile=/dev/stderr
-stdout_logfile_maxbytes=0
-stderr_logfile_maxbytes=0
+stdout_logfile=/var/log/nginx_stdout.log
+stderr_logfile=/var/log/nginx_stderr.log
+stdout_logfile_maxbytes=10MB
+stderr_logfile_maxbytes=10MB
+stdout_logfile_backups=5
+stderr_logfile_backups=5
+user=nginx
+stopsignal=QUIT

web/README.md

@@ -1,22 +1,6 @@
-# sv
-
-Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli).
-
-## Creating a project
-
-If you're seeing this, you've probably already done this step. Congrats!
-
-```bash
-# create a new project in the current directory
-npx sv create
-
-# create a new project in my-app
-npx sv create my-app
-```
-
 ## Developing
 
-Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
+Once you've clone the project and installed dependencies with `npm install` , start a development server:
 
 ```bash
 npm run dev
@@ -34,5 +18,3 @@ npm run build
 ```
 
 You can preview the production build with `npm run preview`.
-
-> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.

web/src/app.html

@@ -2,8 +2,33 @@
 <html lang="en">
 	<head>
 		<meta charset="utf-8" />
+		<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" />
+		<title>GoShort - Simplify Your URLs</title>
+		
+		<!-- Favicon -->
 		<link rel="icon" href="%sveltekit.assets%/favicon.png" />
-		<meta name="viewport" content="width=device-width, initial-scale=1" />
+
+		<!-- SEO Meta Tags -->
+		<meta name="description" content="GoShort is a powerful and user-friendly URL shortener. Simplify, manage, and track your links with ease." />
+		<meta name="keywords" content="URL shortener, GoShort, link management, shorten URLs, track links" />
+		<meta name="author" content="GoShort Team" />
+
+		<!-- Social Sharing / Open Graph -->
+		<meta property="og:title" content="GoShort - Simplify Your URLs" />
+		<meta property="og:description" content="GoShort makes it easy to shorten, manage, and track your URLs. Perfect for businesses, marketers, and individuals." />
+		<meta property="og:image" content="%sveltekit.assets%/banner.png" />
+		<meta property="og:type" content="website" />
+
+		<!-- Twitter Card -->
+		<meta name="twitter:card" content="summary_large_image" />
+		<meta name="twitter:title" content="GoShort - Simplify Your URLs" />
+		<meta name="twitter:description" content="Shorten, manage, and track your URLs with GoShort, the ultimate URL shortener." />
+		<meta name="twitter:image" content="%sveltekit.assets%/banner.png" />
+
+		<!-- App Theme -->
+		<meta name="theme-color" content="#4caf50" />
+
+		<!-- SvelteKit Head -->
 		%sveltekit.head%
 	</head>
 	<body data-sveltekit-preload-data="hover">

web/src/components/Footer.svelte

@@ -15,7 +15,7 @@
       <p class="text-sm">
         View the project on
         <a
-          href="https://github.com/your-repo"
+          href="https://github.com/kek-Sec/GoShort"
           target="_blank"
           class="text-blue-600 underline hover:text-blue-500 font-medium"
         >