some small progress on complete rewrite

2024-05-20 07:47:32 +02:00
parent a8eb1a60f5
commit fbf2c789f0
24 changed files with 3844 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,89 @@
+<div id="title" align="center">
+    <img src="./logo.png" width="300">
+    <h1>SimpleMediaUpscalerLite</h1>
+</div>
+
+<div id="badges" align="center">
+    <img src="https://img.shields.io/github/license/simplePCBuilding/SimpleMediaUpscalerLite.svg">
+    <img src="https://img.shields.io/github/repo-size/simplePCBuilding/SimpleMediaUpscalerLite.svg">
+    <img alt="Lines of code" src="https://img.shields.io/tokei/lines/github/simplePCBuilding/SimpleMediaUpscalerLite">
+    <img src="https://img.shields.io/github/languages/top/simplePCBuilding/SimpleMediaUpscalerLite">
+    <img src="https://img.shields.io/github/directory-file-count/simplePCBuilding/SimpleMediaUpscalerLite.svg">
+    <br>
+    <img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/simplePCBuilding/SimpleMediaUpscalerLite">
+    <img alt="GitHub watchers" src="https://img.shields.io/github/watchers/simplePCBuilding/SimpleMediaUpscalerLite">
+    <img src="https://img.shields.io/github/issues-pr-raw/simplePCBuilding/SimpleMediaUpscalerLite">
+    <img alt="GitHub forks" src="https://img.shields.io/github/forks/simplePCBuilding/SimpleMediaUpscalerLite">
+    <img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/simplePCBuilding/SimpleMediaUpscalerLite">
+    <br>
+    <img alt="GitHub all releases" src="https://img.shields.io/github/downloads/simplePCBuilding/SimpleMediaUpscalerLite/total?label=Downloads (total)">
+    <img alt="GitHub release (latest by date)" src="https://img.shields.io/github/downloads/simplePCBuilding/SimpleMediaUpscalerLite/latest/total?label=Downloads (latest)">
+    <img src="https://img.shields.io/github/release/simplePCBuilding/SimpleMediaUpscalerLite.svg">
+    <img src="https://img.shields.io/github/package-json/v/simplePCBuilding/SimpleMediaUpscalerLite.svg?label=Development Version">
+    
+</div>
+smuL (pronounced like "small") is an Electron App with Python CLI to upscale images and videos using multiple different upscaling engines. 
+
+# Functionality
+smuL features a GUI that allows you to select input and output files, scaling factors and many more settings. It can be easily extended using plugins.
+
+
+# Supported OS
+- Windows 10, 11 (officially)
+- Windows XP, Vista, 7, 8 (unofficially through python directly, may cause problems)
+- Any modern Linux distro with wine installed
+
+# Contributing
+If you have any suggestions or features you'd like to have implemented, you may either implement the feature yourself and open a pull request, or open an issue on this GitHub page. Both things are appreciated!
+
+--> Follow the rules layed out in CONTRIBUTING.md
+--> We will add a linter that will then run on circleci to ensure code quality is high
+
+### Current Contributers
+- simplePCBuilding (Maintainer) [Core (CLI), Docs, Website, Frontend, Linux packages]
+- ThatPlasma (Testing, Packager) [Testing]
+
+
+# Roadmap
+V2.0.0: 
+- Migrate to Electron app -- ✅
+- Package Windows & Linux Version -- ✅
+- Add packaging script for Linux & Windows version -- ✅
+- Make python app CLI only -- ✅
+- Refactor backend to add plugin support -- ✅
+
+V2.1.0:
+- Add more scaling engines 
+- Expand Wiki to feature documentation on how to create a plugin (and maybe add a project website)
+- Show progress of scaling
+
+# Issues
+If you encounter any problems with this app, please don't hesitate to open an issue on GitHub.
+
+## Known issues
+- Electron App is not available yet
+- Electron App shows that it is out of date if running in the development version
+- GTK version only runs on Linux
+
+# FAQ
+**Q: Can you add upscaling engine [upscaling engine here]?**
+
+A: We can add it most likely, please open an issue that contains a link to the library and please try and upscale an image using it yourself and copy-paste the command into a comment.
+Just remember that it might take time to implement it and this is all developed in our free time and we have no obligation to implement it.
+
+**Q: App no worky on OS XXXX**
+
+A: Please check [Supported OS](#supported-os) that your OS is actually supported officially. If so, please open an issue and provide command used (if CLI) and error message that the app spat out when running.
+If the OS is not officially supported, we may not be able to help you, since we intentionally don't support it officially
+
+**Q: Why no worky on MacOS? / Can you port to MacOS?**
+
+A: Wine support on MacOS is still mediocre and most likely cannot run some of the upscalers included by default so we cannot support it. I will be testing it at some point in a VM, but that won't necesarily speak for full functionality. If you find a way to run all upscalers on Mac, feel free to open a PR to add that functionality or just let us know what you did in an issue.
+
+**Q: Upscaled XXX looks not as great as I want**
+
+A: Try out different engines (that's why we support so many) and try to use sharpening to improve quality. If it doesn't help, you might want to suggest another engine.
+
+**Q: How can I support you?**
+
+A: You may contribute to this project by writing documentation, improving the website, adding plugins, fixing bugs, testing or by donating. 
--- a/assets/logo.png
+++ b/assets/logo.png
--- a/assets/logo.xcf
+++ b/assets/logo.xcf
--- a/gui/.eslintrc.cjs
+++ b/gui/.eslintrc.cjs
@@ -0,0 +1,14 @@
+/* eslint-env node */
+require('@rushstack/eslint-patch/modern-module-resolution')
+
+module.exports = {
+  root: true,
+  'extends': [
+    'plugin:vue/vue3-essential',
+    'eslint:recommended',
+    '@vue/eslint-config-typescript'
+  ],
+  parserOptions: {
+    ecmaVersion: 'latest'
+  }
+}
--- a/gui/.gitignore
+++ b/gui/.gitignore
@@ -0,0 +1,30 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+.DS_Store
+dist
+dist-ssr
+coverage
+*.local
+
+/cypress/videos/
+/cypress/screenshots/
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+*.tsbuildinfo
--- a/gui/.vscode/extensions.json
+++ b/gui/.vscode/extensions.json
@@ -0,0 +1,7 @@
+{
+  "recommendations": [
+    "Vue.volar",
+    "Vue.vscode-typescript-vue-plugin",
+    "dbaeumer.vscode-eslint"
+  ]
+}
--- a/gui/README.md
+++ b/gui/README.md
@@ -0,0 +1,46 @@
+# SimpleMediaUpscalerLite
+
+This template should help get you started developing with Vue 3 in Vite.
+
+## Recommended IDE Setup
+
+[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
+
+## Type Support for `.vue` Imports in TS
+
+TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
+
+If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
+
+1. Disable the built-in TypeScript Extension
+    1) Run `Extensions: Show Built-in Extensions` from VSCode's command palette
+    2) Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
+2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
+
+## Customize configuration
+
+See [Vite Configuration Reference](https://vitejs.dev/config/).
+
+## Project Setup
+
+```sh
+npm install
+```
+
+### Compile and Hot-Reload for Development
+
+```sh
+npm run dev
+```
+
+### Type-Check, Compile and Minify for Production
+
+```sh
+npm run build
+```
+
+### Lint with [ESLint](https://eslint.org/)
+
+```sh
+npm run lint
+```
--- a/gui/env.d.ts
+++ b/gui/env.d.ts
@@ -0,0 +1 @@
+/// <reference types="vite/client" />
--- a/gui/index.html
+++ b/gui/index.html
@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8">
+    <link rel="icon" href="/favicon.ico">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Vite App</title>
+  </head>
+  <body>
+    <div id="app"></div>
+    <script type="module" src="/src/main.ts"></script>
+  </body>
+</html>
--- a/gui/package-lock.json
+++ b/gui/package-lock.json
--- a/gui/package.json
+++ b/gui/package.json
@@ -0,0 +1,33 @@
+{
+  "name": "smul",
+  "version": "0.0.0",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "run-p type-check \"build-only {@}\" --",
+    "preview": "vite preview",
+    "build-only": "vite build",
+    "type-check": "vue-tsc --build --force",
+    "lint": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --fix --ignore-path .gitignore"
+  },
+  "dependencies": {
+    "pinia": "^2.1.7",
+    "vue": "^3.4.15",
+    "vue-router": "^4.2.5"
+  },
+  "devDependencies": {
+    "@rushstack/eslint-patch": "^1.3.3",
+    "@tsconfig/node20": "^20.1.2",
+    "@types/node": "^20.11.10",
+    "@vitejs/plugin-vue": "^5.0.3",
+    "@vue/eslint-config-typescript": "^12.0.0",
+    "@vue/tsconfig": "^0.5.1",
+    "eslint": "^8.49.0",
+    "eslint-plugin-vue": "^9.17.0",
+    "npm-run-all2": "^6.1.1",
+    "typescript": "~5.3.0",
+    "vite": "^5.0.11",
+    "vue-tsc": "^1.8.27"
+  }
+}
--- a/gui/public/favicon.ico
+++ b/gui/public/favicon.ico
--- a/gui/src/App.vue
+++ b/gui/src/App.vue
@@ -0,0 +1,199 @@
+<!--
+*				libreevent - App.vue
+*
+*	Created by Janis Hutz 05/14/2023, Licensed under the GPL V3 License
+*			https://janishutz.com, development@janishutz.com
+*
+*
+-->
+
+<template>
+    <div>
+        <nav>
+            <router-link to="/" class="main-nav-item">Home</router-link> | 
+            <router-link to="/about" class="main-nav-item">About</router-link> | 
+            <router-link to="/settings" class="main-nav-item">Settings</router-link>
+        </nav>
+        <router-view v-slot="{ Component, route }" id="main-view">
+            <transition :name="route.meta.transition ? String( route.meta.transition ) : 'fade'" mode="out-in">
+                <component :is="Component"></component>
+            </transition>
+        </router-view>
+    </div>
+</template>
+
+<style>
+body {
+    background-color: var(--background-color);
+}
+
+:root,
+:root.light {
+    --primary-color: #0a1520;
+    --secondary-color: white;
+    --background-color: rgb(221, 221, 221);
+    --nav-background: white;
+    --hover-color: #00457a;
+    --popup-color: rgb(224, 224, 224);
+    --overlay-color: rgba(0, 0, 0, 0.7);
+    --PI: 3.14159265358979;
+    --gray-color: rgb(53, 53, 53);
+    --footer-background: rgb(233, 233, 233);
+    --accent-background: rgb(195, 235, 243);
+}
+
+:root.dark {
+    --primary-color: white;
+    --secondary-color: black;
+    --background-color: rgb(32, 32, 32);
+    --nav-background: rgb(54, 54, 54);
+    --popup-color: rgb(58, 58, 58);
+    --hover-color: #007ddd;
+    --overlay-color: rgba(104, 104, 104, 0.575);
+    --gray-color: rgb(207, 207, 207);
+    --footer-background: rgb(53, 53, 53);
+    --accent-background: rgb(24, 12, 58);
+}
+
+@media (prefers-color-scheme: dark) {
+    :root {
+        --primary-color: white;
+        --secondary-color: black;
+        --background-color: rgb(32, 32, 32);
+        --nav-background: rgb(54, 54, 54);
+        --popup-color: rgb(58, 58, 58);
+        --hover-color: #007ddd;
+        --overlay-color: rgba(104, 104, 104, 0.575);
+        --gray-color: rgb(207, 207, 207);
+        --footer-background: rgb(53, 53, 53);
+        --accent-background: rgb(24, 12, 58);
+    }
+}
+
+::selection {
+    background-color: #7c8cec;
+    color: white;
+}
+
+html,
+body {
+    width: 100%;
+    height: 100%;
+    margin: 0;
+    padding: 0;
+    font-size: 17px;
+}
+
+#app {
+    transition: 0.5s;
+    background-color: var(--background-color);
+    font-family: 'Plus Jakarta Sans', sans-serif;
+    /* font-family: Avenir, Helvetica, Arial, sans-serif; */
+    -webkit-font-smoothing: antialiased;
+    -moz-osx-font-smoothing: grayscale;
+    text-align: center;
+    color: var(--primary-color);
+    display: flex;
+    flex-direction: column;
+    flex-grow: 1;
+    width: 100vw;
+    margin: 0;
+}
+
+#main-view {
+    min-height: 60vh;
+}
+
+.scale-enter-active,
+.scale-leave-active {
+    transition: all 0.5s ease;
+}
+
+.scale-enter-from,
+.scale-leave-to {
+    opacity: 0;
+    transform: scale(0.9);
+}
+
+.fade-enter-active,
+.fade-leave-active {
+    transition: opacity 0.4s ease;
+}
+
+.fade-enter-from,
+.fade-leave-to {
+    opacity: 0;
+}
+
+.material-symbols-outlined {
+    font-variation-settings:
+        'FILL' 0,
+        'wght' 400,
+        'GRAD' 0,
+        'opsz' 48
+}
+
+.clr-open {
+    border: black solid 1px !important;
+}
+</style>
+
+<style>
+    nav {
+        height: 10vh;
+        display: flex;
+        justify-content: center;
+        align-items: center;
+    }
+
+    .main-nav-item {
+        color: black;
+    }
+
+    .main-nav-item.router-link-exact-active {
+        color: #2080ca;
+    }
+</style>
+
+<style>
+.fancy-button {
+    text-decoration: none;
+    color: white;
+    padding: 20px;
+    border-radius: 20px;
+    border: none;
+    background: linear-gradient(45deg, rgb(0, 33, 139), rgb(151, 0, 0));
+    font-size: larger;
+    transition: all 0.5s;
+    background-size: 150%;
+    cursor: pointer;
+}
+
+.fancy-button:hover {
+    border-radius: 5px;
+    background-position: 50%;
+}
+
+.fancy-button-inactive {
+    background: linear-gradient(45deg, rgba(0, 33, 139, 0.6), rgba(151, 0, 0, 0.6));
+    cursor: not-allowed;
+}
+
+.fancy-button-inactive:hover {
+    border-radius: 20px;
+    background-position: 0px;
+}
+</style>
+
+<script setup lang="ts">
+import { RouterView } from 'vue-router';
+import { ref } from 'vue';
+
+let isAtTop = ref( true );
+
+if ( window.scrollY === 0 ) {
+    isAtTop.value = true;
+} else {
+    isAtTop.value = false;
+}
+</script>
--- a/gui/src/assets/logo.png
+++ b/gui/src/assets/logo.png
--- a/gui/src/main.ts
+++ b/gui/src/main.ts
@@ -0,0 +1,12 @@
+import { createApp } from 'vue'
+import { createPinia } from 'pinia'
+
+import App from './App.vue'
+import router from './router'
+
+const app = createApp(App)
+
+app.use(createPinia())
+app.use(router)
+
+app.mount('#app')
--- a/gui/src/router/index.ts
+++ b/gui/src/router/index.ts
@@ -0,0 +1,25 @@
+import { createRouter, createWebHistory } from 'vue-router'
+import HomeView from '../views/HomeView.vue'
+
+const router = createRouter({
+  history: createWebHistory(import.meta.env.BASE_URL),
+  routes: [
+    {
+      path: '/',
+      name: 'home',
+      component: HomeView
+    },
+    {
+      path: '/about',
+      name: 'about',
+      component: () => import('../views/AboutView.vue')
+    },
+    {
+      path: '/settings',
+      name: 'settings',
+      component: () => import('../views/SettingsView.vue')
+    }
+  ]
+})
+
+export default router
--- a/gui/src/stores/counter.ts
+++ b/gui/src/stores/counter.ts
@@ -0,0 +1,12 @@
+import { ref, computed } from 'vue'
+import { defineStore } from 'pinia'
+
+export const useCounterStore = defineStore('counter', () => {
+  const count = ref(0)
+  const doubleCount = computed(() => count.value * 2)
+  function increment() {
+    count.value++
+  }
+
+  return { count, doubleCount, increment }
+})
--- a/gui/src/views/AboutView.vue
+++ b/gui/src/views/AboutView.vue
@@ -0,0 +1,7 @@
+<template>
+    <div class="about">
+        <img src="@/assets/logo.png" alt="smuL Logo">
+        <h1>SimpleMediaUpscalerLite</h1>
+    </div>
+</template>
+
--- a/gui/src/views/HomeView.vue
+++ b/gui/src/views/HomeView.vue
@@ -0,0 +1,9 @@
+<script setup lang="ts">
+
+</script>
+
+<template>
+    <main>
+        <h1>SimpleMediaUpscalerLite</h1>
+    </main>
+</template>
--- a/gui/src/views/SettingsView.vue
+++ b/gui/src/views/SettingsView.vue
@@ -0,0 +1,7 @@
+<template>
+    <div class="about">
+        <h1>Settings</h1>
+        <img src="@/assets/logo.png" alt="smuL Logo">
+    </div>
+</template>
+
--- a/gui/tsconfig.app.json
+++ b/gui/tsconfig.app.json
@@ -0,0 +1,14 @@
+{
+  "extends": "@vue/tsconfig/tsconfig.dom.json",
+  "include": ["env.d.ts", "src/**/*", "src/**/*.vue"],
+  "exclude": ["src/**/__tests__/*"],
+  "compilerOptions": {
+    "composite": true,
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.app.tsbuildinfo",
+
+    "baseUrl": ".",
+    "paths": {
+      "@/*": ["./src/*"]
+    }
+  }
+}
--- a/gui/tsconfig.json
+++ b/gui/tsconfig.json
@@ -0,0 +1,11 @@
+{
+  "files": [],
+  "references": [
+    {
+      "path": "./tsconfig.node.json"
+    },
+    {
+      "path": "./tsconfig.app.json"
+    }
+  ]
+}
--- a/gui/tsconfig.node.json
+++ b/gui/tsconfig.node.json
@@ -0,0 +1,19 @@
+{
+  "extends": "@tsconfig/node20/tsconfig.json",
+  "include": [
+    "vite.config.*",
+    "vitest.config.*",
+    "cypress.config.*",
+    "nightwatch.conf.*",
+    "playwright.config.*"
+  ],
+  "compilerOptions": {
+    "composite": true,
+    "noEmit": true,
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo",
+
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "types": ["node"]
+  }
+}
--- a/gui/vite.config.ts
+++ b/gui/vite.config.ts
@@ -0,0 +1,19 @@
+import { fileURLToPath, URL } from 'node:url'
+
+import { defineConfig } from 'vite'
+import vue from '@vitejs/plugin-vue'
+
+// https://vitejs.dev/config/
+export default defineConfig({
+    plugins: [
+        vue(),
+    ],
+    resolve: {
+        alias: {
+            '@': fileURLToPath(new URL('./src', import.meta.url))
+        }
+    },
+    server: {
+        port: 8080
+    }
+})