Upstream merge

.docker.env

@@ -18,16 +18,11 @@ DB_USER=
 DB_PASSWORD=
 DB_SSL=false
 
-# ONLY NEEDED FOR MIGRATION !!1!
-# Neo4j database credential details
-NEO4J_DB_URI=bolt://localhost
-NEO4J_DB_USERNAME=neo4j
-NEO4J_DB_PASSWORD=BjEphmupAf1D5pDD
-
 # Redis host and port
 REDIS_HOST=redis
 REDIS_PORT=6379
 REDIS_PASSWORD=
+REDIS_DB=
 
 # Disable registration
 DISALLOW_REGISTRATION=false
@@ -64,15 +59,6 @@ RECAPTCHA_SECRET_KEY=
 # Get it from https://developers.google.com/safe-browsing/v4/get-started
 GOOGLE_SAFE_BROWSING_KEY=
 
-# Google Analytics tracking ID for universal analytics.
-# Example: UA-XXXX-XX
-GOOGLE_ANALYTICS=
-GOOGLE_ANALYTICS_UNIVERSAL=
-
-# Google Analytics tracking ID for universal analytics
-# This one is used for links
-# GOOGLE_ANALYTICS_UNIVERSAL=
-
 # Your email host details to use to send verification emails.
 # More info on http://nodemailer.com/
 # Mail from example "Kutt <[email protected]>". Leave empty to use MAIL_USER

.eslintrc

@@ -1,39 +1,22 @@
 {
  "extends": [
- "eslint:recommended",
+ "next/core-web-vitals",
  "plugin:@typescript-eslint/recommended",
- "plugin:prettier/recommended"
+ "prettier"
  ],
- "parser": "@typescript-eslint/parser",
  "parserOptions": {
+ "ecmaVersion": "latest",
+ "sourceType": "module",
  "project": ["./tsconfig.json", "./client/tsconfig.json"]
  },
- "plugins": ["@typescript-eslint"],
+ "plugins": ["@typescript-eslint", "prettier"],
  "rules": {
- "eqeqeq": ["warn", "always", { "null": "ignore" }],
- "no-useless-return": "warn",
- "no-var": "warn",
- "no-console": "warn",
- "max-len": ["warn", { "comments": 80 }],
- "no-param-reassign": 0,
- "require-atomic-updates": 0,
- "@typescript-eslint/interface-name-prefix": "off",
- "@typescript-eslint/no-unused-vars": "off", // "warn" for production
- "@typescript-eslint/no-explicit-any": "off", // "warn" for production
- "@typescript-eslint/no-var-requires": "off",
- "@typescript-eslint/camelcase": "off",
- "@typescript-eslint/no-object-literal-type-assertion": "off",
- "@typescript-eslint/no-parameter-properties": "off",
- "@typescript-eslint/explicit-function-return-type": "off"
+ "@typescript-eslint/no-explicit-any": ["off"]
  },
  "env": {
  "es6": true,
  "browser": true,
- "node": true,
- "mocha": true
- },
- "globals": {
- "assert": true
+ "node": true
  },
  "settings": {
  "react": {

.example.env

@@ -18,16 +18,13 @@ DB_USER=
 DB_PASSWORD=
 DB_SSL=false
 
-# ONLY NEEDED FOR MIGRATION !!1!
-# Neo4j database credential details
-NEO4J_DB_URI=bolt://localhost
-NEO4J_DB_USERNAME=neo4j
-NEO4J_DB_PASSWORD=BjEphmupAf1D5pDD
-
 # Redis host and port
 REDIS_HOST=127.0.0.1
 REDIS_PORT=6379
 REDIS_PASSWORD=
+# Optional: The number for Redis database, between 0 and 15. Defaults to 0.
+# If you don't know what this is, then you probably don't need to change it.
+REDIS_DB=0
 
 # Disable registration
 DISALLOW_REGISTRATION=false
@@ -65,15 +62,6 @@ RECAPTCHA_SECRET_KEY=
 # Get it from https://developers.google.com/safe-browsing/v4/get-started
 GOOGLE_SAFE_BROWSING_KEY=
 
-# Google Analytics tracking ID for universal analytics.
-# Example: UA-XXXX-XX
-GOOGLE_ANALYTICS=
-GOOGLE_ANALYTICS_UNIVERSAL=
-
-# Google Analytics tracking ID for universal analytics
-# This one is used for links
-# GOOGLE_ANALYTICS_UNIVERSAL=
-
 # Your email host details to use to send verification emails.
 # More info on http://nodemailer.com/
 # Mail from example "Kutt <[email protected]>". Leave empty to use MAIL_USER

.github/workflows/docker-build-latest.yaml

@@ -0,0 +1,45 @@
+name: docker-build-latest
+
+env:
+ dockerhub_repository: "kutt/kutt"
+ dockerhub_tag: "develop"
+
+on:
+ push:
+ branches:
+ - develop
+
+jobs:
+ dockerhub-build-push:
+ runs-on: ubuntu-latest
+ steps:
+ -
+ name: Checkout
+ uses: actions/checkout@v2
+ -
+ name: Set up QEMU
+ uses: docker/setup-qemu-action@v1
+ -
+ name: Set up Docker Buildx
+ uses: docker/setup-buildx-action@v1
+ -
+ name: Login to DockerHub
+ uses: docker/login-action@v1 
+ with:
+ username: ${{ secrets.DOCKERHUB_USERNAME }}
+ password: ${{ secrets.DOCKERHUB_TOKEN }}
+ -
+ name: Build and push
+ uses: docker/build-push-action@v2
+ with:
+ context: .
+ platforms: linux/amd64,linux/arm64,linux/arm/v7
+ push: true
+ tags: ${{ env.dockerhub_repository }}:${{ env.dockerhub_tag }}
+ -
+ name: Update repo description
+ uses: peter-evans/dockerhub-description@v2
+ with:
+ username: ${{ secrets.DOCKERHUB_USERNAME }}
+ password: ${{ secrets.DOCKERHUB_PASSWORD }}
+ repository: ${{ env.dockerhub_repository }}

.github/workflows/docker-build-release.yaml

@@ -0,0 +1,36 @@
+name: docker-build-latest
+
+env:
+ dockerhub_repository: "kutt/kutt"
+
+on:
+ release:
+ types: [published]
+
+jobs:
+ dockerhub-build-push:
+ runs-on: ubuntu-latest
+ steps:
+ -
+ name: Checkout
+ uses: actions/checkout@v2
+ -
+ name: Set up QEMU
+ uses: docker/setup-qemu-action@v1
+ -
+ name: Set up Docker Buildx
+ uses: docker/setup-buildx-action@v1
+ -
+ name: Login to DockerHub
+ uses: docker/login-action@v1 
+ with:
+ username: ${{ secrets.DOCKERHUB_USERNAME }}
+ password: ${{ secrets.DOCKERHUB_TOKEN }}
+ -
+ name: Build and push
+ uses: docker/build-push-action@v2
+ with:
+ context: .
+ platforms: linux/amd64,linux/arm64,linux/arm/v7
+ push: true
+ tags: ${{ env.dockerhub_repository }}:${{ github.event.release.tag_name }}, ${{ env.dockerhub_repository }}:latest

.gitignore

@@ -1,5 +1,6 @@
 .env
 .vscode/
+logs
 client/.next/
 node_modules/
 client/config.js

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npm run lint:nofix

README.md

@@ -13,12 +13,6 @@ _Contributions and bug reports are welcome._
 [![GitHub license](https://img.shields.io/github/license/thedevs-network/kutt.svg)](https://github.com/thedevs-network/kutt/blob/develop/LICENSE)
 [![Twitter](https://img.shields.io/twitter/url/https/github.com/thedevs-network/kutt/.svg?style=social)](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2Fthedevs-network%2Fkutt%2F)
 
-## Migration from v1
-
-The new version of Kutt is here. In version 2, we used TypeScript and we moved from Neo4j to PostgreSQL database in favor of performance and we're working on adding new features.
-
-If you're coming from v1, refer to [MIGRATION.md](MIGRATION.md) to migrate data from Neo4j to PostgreSQL.
-
 ## Table of Contents
 
 - [Key Features](#key-features)
@@ -72,8 +66,9 @@ You need to have [Node.js](https://nodejs.org/), [PostgreSQL](https://www.postgr
 
 ### Docker
 
-Download the `docker-compose.yml` and the `.docker.env`-file from the repository and configure the `.docker.env` ([see below](#configuration)). 
-To execute Kutt you simply have to run `docker-compose up -d` command and then the app should be ready on port "3000".
+1. Download the [`docker-compose.yml`](https://raw.githubusercontent.com/thedevs-network/kutt/develop/docker-compose.yml) and the [`.docker.env`](https://raw.githubusercontent.com/thedevs-network/kutt/develop/.docker.env) files.
+2. Rename `.docker.env` to `.env` and fill it properly ([see below](#configuration)).
+3. To execute Kutt you simply have to run `docker-compose up -d` command and then the app should be ready on port "3000".
 
 The `docker-compose.yml` uses the official kutt docker image available on [Docker Hub](https://hub.docker.com/r/kutt/kutt).
 
@@ -110,17 +105,20 @@ You can use Kutt as your default URL shortener in [ShareX](https://getsharex.com
 Download Kutt's official workflow for [Alfred](https://www.alfredapp.com/) app from [alfred-kutt](https://github.com/thedevs-network/alfred-kutt) repository.
 
 ## 3rd Party packages
-| Language | Link | Description |
-| ---------- | ---------------------------------------------------------- | -------------------------------------------------- |
-| C# (.NET) | [KuttSharp](https://github.com/0xaryan/KuttSharp) | .NET package for Kutt.it url shortener |
-| Python | [kutt-cli](https://github.com/RealAmirali/kutt-cli) | Command-line client for Kutt written in Python |
-| Ruby | [kutt.rb](https://github.com/RealAmirali/kutt.rb) | Kutt library written in Ruby |
-| Rust | [urlshortener](https://github.com/vityafx/urlshortener-rs) | URL shortener library written in Rust |
-| Rust | [kutt-rs](https://github.com/robatipoor/kutt-rs) | Command line tool written in Rust |
-| Node.js | [node-kutt](https://github.com/ardalanamini/node-kutt) | Node.js client for Kutt.it url shortener |
-| JavaScript | [kutt-vscode](https://github.com/mehrad77/kutt-vscode) | Visual Studio Code extention for Kutt |
-| Java | [kutt-desktop](https://github.com/cipher812/kutt-desktop) | A Cross platform Java desktop application for Kutt |
-| Go | [kutt-go](https://github.com/raahii/kutt-go) | Go client for Kutt.it url shortener |
+| Language | Link | Description |
+| ---------- | --------------------------------------------------------------------------------- | -------------------------------------------------- |
+| C# (.NET) | [KuttSharp](https://github.com/0xaryan/KuttSharp) | .NET package for Kutt.it url shortener |
+| C# (.NET) | [Kutt.NET](https://github.com/AlphaNecron/Kutt.NET) | ✂️🔗 C# API Wrapper for Kutt
+| Python | [kutt-cli](https://github.com/RealAmirali/kutt-cli) | Command-line client for Kutt written in Python |
+| Ruby | [kutt.rb](https://github.com/RealAmirali/kutt.rb) | Kutt library written in Ruby |
+| Rust | [urlshortener](https://github.com/vityafx/urlshortener-rs) | URL shortener library written in Rust |
+| Rust | [kutt-rs](https://github.com/robatipoor/kutt-rs) | Command line tool written in Rust |
+| Node.js | [node-kutt](https://github.com/ardalanamini/node-kutt) | Node.js client for Kutt.it url shortener |
+| JavaScript | [kutt-vscode](https://github.com/mehrad77/kutt-vscode) | Visual Studio Code extension for Kutt |
+| Java | [kutt-desktop](https://github.com/cipher812/kutt-desktop) | A Cross platform Java desktop application for Kutt |
+| Go | [kutt-go](https://github.com/raahii/kutt-go) | Go client for Kutt.it url shortener |
+| BASH | [GitHub Gist](https://gist.github.com/hashworks/6d6e4eae8984a5018f7692a796d570b4) | Simple BASH function to access the API |
+| BASH | [url-shortener](https://git.tim-peters.org/Tim/url-shortener) | Simple BASH script with GUI |
 
 ## Donate