add: build

improve: project structure
This commit is contained in:
alikia2x (寒寒) 2024-12-01 06:23:37 +08:00
parent ab9a51bfad
commit be6be8280e
Signed by: alikia2x
GPG Key ID: 56209E0CCD8420C6
28 changed files with 2045 additions and 79 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 280 B

View File

@ -1 +0,0 @@
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="35.93" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 228"><path fill="#00D8FF" d="M210.483 73.824a171.49 171.49 0 0 0-8.24-2.597c.465-1.9.893-3.777 1.273-5.621c6.238-30.281 2.16-54.676-11.769-62.708c-13.355-7.7-35.196.329-57.254 19.526a171.23 171.23 0 0 0-6.375 5.848a155.866 155.866 0 0 0-4.241-3.917C100.759 3.829 77.587-4.822 63.673 3.233C50.33 10.957 46.379 33.89 51.995 62.588a170.974 170.974 0 0 0 1.892 8.48c-3.28.932-6.445 1.924-9.474 2.98C17.309 83.498 0 98.307 0 113.668c0 15.865 18.582 31.778 46.812 41.427a145.52 145.52 0 0 0 6.921 2.165a167.467 167.467 0 0 0-2.01 9.138c-5.354 28.2-1.173 50.591 12.134 58.266c13.744 7.926 36.812-.22 59.273-19.855a145.567 145.567 0 0 0 5.342-4.923a168.064 168.064 0 0 0 6.92 6.314c21.758 18.722 43.246 26.282 56.54 18.586c13.731-7.949 18.194-32.003 12.4-61.268a145.016 145.016 0 0 0-1.535-6.842c1.62-.48 3.21-.974 4.76-1.488c29.348-9.723 48.443-25.443 48.443-41.52c0-15.417-17.868-30.326-45.517-39.844Zm-6.365 70.984c-1.4.463-2.836.91-4.3 1.345c-3.24-10.257-7.612-21.163-12.963-32.432c5.106-11 9.31-21.767 12.459-31.957c2.619.758 5.16 1.557 7.61 2.4c23.69 8.156 38.14 20.213 38.14 29.504c0 9.896-15.606 22.743-40.946 31.14Zm-10.514 20.834c2.562 12.94 2.927 24.64 1.23 33.787c-1.524 8.219-4.59 13.698-8.382 15.893c-8.067 4.67-25.32-1.4-43.927-17.412a156.726 156.726 0 0 1-6.437-5.87c7.214-7.889 14.423-17.06 21.459-27.246c12.376-1.098 24.068-2.894 34.671-5.345a134.17 134.17 0 0 1 1.386 6.193ZM87.276 214.515c-7.882 2.783-14.16 2.863-17.955.675c-8.075-4.657-11.432-22.636-6.853-46.752a156.923 156.923 0 0 1 1.869-8.499c10.486 2.32 22.093 3.988 34.498 4.994c7.084 9.967 14.501 19.128 21.976 27.15a134.668 134.668 0 0 1-4.877 4.492c-9.933 8.682-19.886 14.842-28.658 17.94ZM50.35 144.747c-12.483-4.267-22.792-9.812-29.858-15.863c-6.35-5.437-9.555-10.836-9.555-15.216c0-9.322 13.897-21.212 37.076-29.293c2.813-.98 5.757-1.905 8.812-2.773c3.204 10.42 7.406 21.315 12.477 32.332c-5.137 11.18-9.399 22.249-12.634 32.792a134.718 134.718 0 0 1-6.318-1.979Zm12.378-84.26c-4.811-24.587-1.616-43.134 6.425-47.789c8.564-4.958 27.502 2.111 47.463 19.835a144.318 144.318 0 0 1 3.841 3.545c-7.438 7.987-14.787 17.08-21.808 26.988c-12.04 1.116-23.565 2.908-34.161 5.309a160.342 160.342 0 0 1-1.76-7.887Zm110.427 27.268a347.8 347.8 0 0 0-7.785-12.803c8.168 1.033 15.994 2.404 23.343 4.08c-2.206 7.072-4.956 14.465-8.193 22.045a381.151 381.151 0 0 0-7.365-13.322Zm-45.032-43.861c5.044 5.465 10.096 11.566 15.065 18.186a322.04 322.04 0 0 0-30.257-.006c4.974-6.559 10.069-12.652 15.192-18.18ZM82.802 87.83a323.167 323.167 0 0 0-7.227 13.238c-3.184-7.553-5.909-14.98-8.134-22.152c7.304-1.634 15.093-2.97 23.209-3.984a321.524 321.524 0 0 0-7.848 12.897Zm8.081 65.352c-8.385-.936-16.291-2.203-23.593-3.793c2.26-7.3 5.045-14.885 8.298-22.6a321.187 321.187 0 0 0 7.257 13.246c2.594 4.48 5.28 8.868 8.038 13.147Zm37.542 31.03c-5.184-5.592-10.354-11.779-15.403-18.433c4.902.192 9.899.29 14.978.29c5.218 0 10.376-.117 15.453-.343c-4.985 6.774-10.018 12.97-15.028 18.486Zm52.198-57.817c3.422 7.8 6.306 15.345 8.596 22.52c-7.422 1.694-15.436 3.058-23.88 4.071a382.417 382.417 0 0 0 7.859-13.026a347.403 347.403 0 0 0 7.425-13.565Zm-16.898 8.101a358.557 358.557 0 0 1-12.281 19.815a329.4 329.4 0 0 1-23.444.823c-7.967 0-15.716-.248-23.178-.732a310.202 310.202 0 0 1-12.513-19.846h.001a307.41 307.41 0 0 1-10.923-20.627a310.278 310.278 0 0 1 10.89-20.637l-.001.001a307.318 307.318 0 0 1 12.413-19.761c7.613-.576 15.42-.876 23.31-.876H128c7.926 0 15.743.303 23.354.883a329.357 329.357 0 0 1 12.335 19.695a358.489 358.489 0 0 1 11.036 20.54a329.472 329.472 0 0 1-11 20.722Zm22.56-122.124c8.572 4.944 11.906 24.881 6.52 51.026c-.344 1.668-.73 3.367-1.15 5.09c-10.622-2.452-22.155-4.275-34.23-5.408c-7.034-10.017-14.323-19.124-21.64-27.008a160.789 160.789 0 0 1 5.888-5.4c18.9-16.447 36.564-22.941 44.612-18.3ZM128 90.808c12.625 0 22.86 10.235 22.86 22.86s-10.235 22.86-22.86 22.86s-22.86-10.235-22.86-22.86s10.235-22.86 22.86-22.86Z"></path></svg>

Before

Width:  |  Height:  |  Size: 4.0 KiB

BIN
build/icons/1024x1024.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 454 KiB

26
electron-builder.json Normal file
View File

@ -0,0 +1,26 @@
{
"appId": "com.alikia2x.openrewind",
"mac": {
"category": "public.app-category.productivity",
"target": "dmg"
},
"productName": "OpenRewind",
"directories": {
"output": "dist/release"
},
"files": [
"dist/dev/**/*",
"dist/dev/assets/*",
"dist/dev/i18n/*",
"dist/renderer/**/*",
"dist/renderer/assets/*"
],
"win": {
"target": "nsis"
},
"linux": {
"target": "AppImage"
},
"copyright": "Copyright © 2024 alikia2x",
"asar": false
}

29
gulpfile.ts Normal file
View File

@ -0,0 +1,29 @@
import gulp from "gulp";
import ts from "gulp-typescript";
// @ts-ignore
import clean from "gulp-clean";
const tsProject = ts.createProject('tsconfig.json');
gulp.task('clean', function () {
return gulp.src('dist/dev', {read: false, allowEmpty: true})
.pipe(clean());
});
gulp.task('scripts', () => {
const tsResult = tsProject.src()
.pipe(tsProject());
return tsResult.js.pipe(gulp.dest('dist/dev'));
});
gulp.task('assets', () => {
return gulp.src('src/electron/assets/**/*')
.pipe(gulp.dest('dist/dev/assets'));
});
gulp.task("locales", () => {
return gulp.src('i18n/**/*')
.pipe(gulp.dest('dist/dev/i18n'));
})
gulp.task('build', gulp.series('clean', 'scripts', 'assets', 'locales'));

View File

@ -1,3 +1,8 @@
{
"settings": "Settings"
"settings": "Settings",
"tray": {
"showMainWindow": "Search",
"showSettingsWindow": "Settings",
"quit": "Quit"
}
}

8
i18n/zh-CN.json Normal file
View File

@ -0,0 +1,8 @@
{
"settings": "设置",
"tray": {
"showMainWindow": "搜索…",
"showSettingsWindow": "应用设置",
"quit": "退出 OpenRewind"
}
}

View File

@ -1,3 +0,0 @@
{
"settings": "设置"
}

View File

@ -1,13 +1,14 @@
{
"name": "openrewind",
"version": "1.0.0",
"version": "0.1.1",
"type": "module",
"description": "",
"description": "Your second brain, superpowered.",
"main": "dist/dev/index.js",
"scripts": {
"dev": "cross-env NODE_ENV=dev bun run dev:all",
"dev:all": "concurrently -n=react,electron -c='#ff3e00',blue \"bun run dev:react\" \"bun run dev:electron\"",
"dev:react": "vite dev",
"dev:electron": "tsc && electron dist/dev/index.js",
"dev:electron": "bunx gulp build && electron dist/dev/index.js",
"build": "cross-env NODE_ENV=production bun run build:all",
"build:all": "concurrently -n=react,electron -c='#ff3e00',blue \"bun run build:react\" \"bun run build:electron\"",
"build:react": "vite build",
@ -18,12 +19,15 @@
"author": "",
"license": "MIT",
"dependencies": {
"@unly/universal-language-detector": "^2.0.3",
"electron-context-menu": "^4.0.4",
"electron-reloader": "^1.2.3",
"electron-serve": "^2.1.1",
"electron-window-state": "^5.0.3",
"i18next": "^24.0.2",
"i18next-browser-languagedetector": "^8.0.0",
"i18next-electron-fs-backend": "^3.0.2",
"i18next-fs-backend": "^2.6.0",
"i18next-icu": "^2.3.0",
"react": "^18.3.1",
"react-dom": "^18.3.1",
@ -32,20 +36,28 @@
"vite-tsconfig-paths": "^5.1.3"
},
"devDependencies": {
"electron": "^33.2.0",
"@eslint/js": "^9.13.0",
"@types/gulp": "^4.0.17",
"@types/react": "^18.3.12",
"@types/react-dom": "^18.3.1",
"@vitejs/plugin-react": "^4.3.3",
"concurrently": "^9.0.1",
"cross-env": "^7.0.3",
"del": "^8.0.0",
"electron": "^33.2.0",
"electron-builder": "^25.1.8",
"eslint": "^9.13.0",
"eslint-plugin-react-hooks": "^5.0.0",
"eslint-plugin-react-refresh": "^0.4.14",
"globals": "^15.11.0",
"gulp": "^5.0.0",
"gulp-clean": "^0.4.0",
"gulp-typescript": "6.0.0-alpha.1",
"tailwindcss": "^3.4.15",
"typescript": "~5.6.2",
"typescript-eslint": "^8.11.0",
"vite": "^5.4.10"
"vite": "^5.4.10",
"postcss": "^8.4.38",
"autoprefixer": "^10.4.19"
}
}

9
pages/rewind/index.tsx Normal file
View File

@ -0,0 +1,9 @@
export default function RewindPage() {
return (
<>
<div className="bg-white dark:bg-gray-900 w-full min-h-screen relative dark:text-white p-4">
<p>timeline</p>
</div>
</>
)
}

View File

@ -1,10 +1,21 @@
import {useTranslation} from "react-i18next";
import "src/renderer/app.css";
import * as pjson from "package.json";
export default function SettingsPage() {
const {t} = useTranslation();
return (
<div>
<h1>{t('settings')}</h1>
<>
<title>{t('settings')}</title>
<div className="w-full h-9 bg-white dark:bg-gray-800 !bg-opacity-80 flex items-center justify-center
dark:text-white font-semibold fixed z-10 backdrop-blur-lg text-[.9rem]" id="title-bar">
{t('settings')}
</div>
<div className="bg-white dark:bg-gray-900 w-full min-h-screen relative dark:text-white pt-16 px-10">
<h1 className="text-3xl font-bold leading-[3rem]">About</h1>
<h2 className="text-lg">OpenRewind</h2>
<span className="text-sm font-semibold">Version: {pjson.version}</span>
</div>
</>
)
}

File diff suppressed because it is too large Load Diff

6
postcss.config.js Normal file
View File

@ -0,0 +1,6 @@
export default {
plugins: {
tailwindcss: {},
autoprefixer: {}
}
};

View File

@ -1 +0,0 @@
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="31.88" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 257"><defs><linearGradient id="IconifyId1813088fe1fbc01fb466" x1="-.828%" x2="57.636%" y1="7.652%" y2="78.411%"><stop offset="0%" stop-color="#41D1FF"></stop><stop offset="100%" stop-color="#BD34FE"></stop></linearGradient><linearGradient id="IconifyId1813088fe1fbc01fb467" x1="43.376%" x2="50.316%" y1="2.242%" y2="89.03%"><stop offset="0%" stop-color="#FFEA83"></stop><stop offset="8.333%" stop-color="#FFDD35"></stop><stop offset="100%" stop-color="#FFA800"></stop></linearGradient></defs><path fill="url(#IconifyId1813088fe1fbc01fb466)" d="M255.153 37.938L134.897 252.976c-2.483 4.44-8.862 4.466-11.382.048L.875 37.958c-2.746-4.814 1.371-10.646 6.827-9.67l120.385 21.517a6.537 6.537 0 0 0 2.322-.004l117.867-21.483c5.438-.991 9.574 4.796 6.877 9.62Z"></path><path fill="url(#IconifyId1813088fe1fbc01fb467)" d="M185.432.063L96.44 17.501a3.268 3.268 0 0 0-2.634 3.014l-5.474 92.456a3.268 3.268 0 0 0 3.997 3.378l24.777-5.718c2.318-.535 4.413 1.507 3.936 3.838l-7.361 36.047c-.495 2.426 1.782 4.5 4.151 3.78l15.304-4.649c2.372-.72 4.652 1.36 4.15 3.788l-11.698 56.621c-.732 3.542 3.979 5.473 5.943 2.437l1.313-2.028l72.516-144.72c1.215-2.423-.88-5.186-3.54-4.672l-25.505 4.922c-2.396.462-4.435-1.77-3.759-4.114l16.646-57.705c.677-2.35-1.37-4.583-3.769-4.113Z"></path></svg>

Before

Width:  |  Height:  |  Size: 1.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 285 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 285 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 477 B

59
src/electron/i18n.ts Normal file
View File

@ -0,0 +1,59 @@
import { join } from "path";
import i18n from "i18next";
import fs from "fs";
import { fileURLToPath } from 'url'
import path from 'path'
const __dirname = path.dirname(fileURLToPath(import.meta.url))
import { app } from 'electron';
/**
* Selects the appropriate language based on system preferences and available languages
*
* @param langs Array of available language codes
* @param fallback Fallback language code to use if no match is found
* @returns Selected language code
*/
export function detectLanguage(langs: string[], fallback: string): string {
// Get the system locale using Electron's app API
// Note: This assumes the function is used in the main process
const systemLanguage = app.getPreferredSystemLanguages()[0];
// Normalize the system locale (convert to lowercase and replace hyphens/underscores)
const normalizedLang = systemLanguage.toLowerCase().split("-")[0];
// Find a matching language
const matchedLanguage = langs.find(lang => {
if (lang.indexOf(normalizedLang) !== -1) {
return lang
}
});
// Return matched language or fallback
return matchedLanguage || fallback;
}
const languages = ['en', 'de', 'es', 'fr', 'it', 'ja', 'ar', 'ko', 'zh-CN'];
const l = detectLanguage(languages, "en");
const resources = languages.reduce((acc: { [key: string]: { translation: any } }, lang) => {
acc[lang] = {
translation: JSON.parse(fs.readFileSync(join(__dirname, `./i18n/${lang}.json`), 'utf8'))
};
return acc;
}, {});
i18n.init({
resources,
lng: l,
fallbackLng: "en",
interpolation: {
escapeValue: false // react already safes from xss => https://www.i18next.com/translation-function/interpolation#unescape
},
});
const t = i18n.t;

View File

@ -1,25 +1,33 @@
import windowStateManager from 'electron-window-state';
import { app, BrowserWindow, screen,ipcMain, globalShortcut, Tray, Menu } from 'electron';
import { app, BrowserWindow, screen,ipcMain, globalShortcut, Tray, Menu, nativeImage } from 'electron';
import contextMenu from 'electron-context-menu';
import serve from 'electron-serve';
import { join } from "path";
import i18n from "i18next";
import "./i18n.js";
const t = i18n.t;
const port = process.env.PORT || "5173";
const dev = !app.isPackaged;
let tray = null
function createTray() {
// 创建托盘图标
tray = new Tray('./assets/icon.png')
const pathRoot: string = dev ? "./src/electron/assets/" : "./assets/";
const icon = nativeImage.createFromPath(pathRoot + 'TrayIconTemplate@2x.png');
icon.resize({ width: 32, height: 32 })
tray = new Tray(pathRoot + 'TrayIcon.png');
tray.setImage(icon);
// 创建托盘菜单
const contextMenu = Menu.buildFromTemplate([
{
label: '显示主窗口',
label: t('tray.showMainWindow'),
click: () => {
if (!mainWindow) createMainWindow();
mainWindow!.show();
}
},
{
label: '显示设置',
label: t('tray.showSettingsWindow'),
click: () => {
if (!settingsWindow) createSettingsWindow();
settingsWindow!.show();
@ -27,41 +35,31 @@ function createTray() {
},
{ type: 'separator' },
{
label: '退出',
label: t('tray.quit'),
click: () => {
app.quit()
}
}
])
// 设置托盘的上下文菜单
tray.setContextMenu(contextMenu)
// 设置托盘的提示文字
tray.setToolTip('我的应用程序')
// 点击托盘图标时显示主窗口
// tray.on('click', () => {
// mainWindow.isVisible() ? mainWindow.hide() : mainWindow.show()
// })
tray.setToolTip('OpenRewind')
}
const serveURL = serve({ directory: '.' });
const port = process.env.PORT || "5173";
const dev = !app.isPackaged;
let mainWindow: BrowserWindow | null;
let settingsWindow: BrowserWindow | null;
function createSettingsWindow() {
const window = new BrowserWindow({
width: 400,
height: 600,
width: 650,
height: 550,
webPreferences: {
nodeIntegration: true,
contextIsolation: false
contextIsolation: true
},
titleBarStyle: 'hiddenInset',
resizable: false,
});
window.once('ready-to-show', () => {
window.show();
@ -71,7 +69,7 @@ function createSettingsWindow() {
settingsWindow = window;
if (dev) loadVite(window ,port, "settings");
else serveURL(mainWindow!);
else settingsWindow.loadFile(join(__dirname, '../renderer/index.html/settings'));
}
contextMenu({
@ -134,8 +132,8 @@ function createMainWindow() {
mainWindow = window;
if (dev) loadVite(window, port);
else serveURL(mainWindow).then(()=>{});
if (dev) loadVite(window, port, "rewind");
else mainWindow.loadFile(join(__dirname, '../renderer/index.html/rewind'));
}
app.once('ready', () => {

3
src/renderer/app.css Normal file
View File

@ -0,0 +1,3 @@
#title-bar {
-webkit-app-region: drag;
}

View File

@ -1,17 +1,22 @@
import { createBrowserRouter, RouterProvider } from "react-router-dom";
import SettingsPage from "pages/settings";
import "./i18n.ts";
import RewindPage from "../../pages/rewind";
const router = createBrowserRouter([
{
path: "/settings",
element: <SettingsPage/>
},
{
path: "/rewind",
element: <RewindPage/>
}
]);
export function App() {
return (
<div>
<div className="w-screen h-screen">
<RouterProvider router={router}/>
</div>
);

View File

@ -1,5 +1,5 @@
import * as en from "i18n/en.json";
import * as zh from "i18n/zh.json";
import * as zh from "i18n/zh-CN.json";
import * as ja from "i18n/ja.json";
import * as de from "i18n/de.json";
import * as es from "i18n/es.json";

View File

@ -2,12 +2,10 @@
<html lang="en">
<head>
<meta charset="UTF-8" />
<link rel="icon" type="image/svg+xml" href="/vite.svg" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Vite + React + TS</title>
</head>
<body>
<div id="root"></div>
<script type="module" src="/src/web/main.tsx"></script>
<script type="module" src="./main.tsx"></script>
</body>
</html>

View File

@ -4,7 +4,7 @@ const config: Config = {
content: [
"./pages/**/*.{js,ts,jsx,tsx,mdx}",
"./components/**/*.{js,ts,jsx,tsx,mdx}",
"./src/**/*.{js,ts,jsx,tsx,mdx}"
"./src/**/*.{js,ts,jsx,tsx,mdx}",
],
theme: {
extend: {

View File

@ -23,5 +23,8 @@
"noUnusedParameters": true,
"noFallthroughCasesInSwitch": true
},
"include": ["src/web", "src/web/**/*.ts", "src/web/**/*.tsx", "global.d.ts"],
"include": [
"src/renderer",
"src/renderer/**/*.ts",
"src/renderer/**/*.tsx", "global.d.ts", "pages/**/*.tsx"],
}

View File

@ -1,8 +1,14 @@
import { defineConfig } from 'vite'
import react from '@vitejs/plugin-react'
import tsconfigPaths from "vite-tsconfig-paths";
import { join } from 'path';
// https://vite.dev/config/
export default defineConfig({
root: join(__dirname, 'src/renderer'),
build: {
outDir: join(__dirname, 'dist/renderer'),
emptyOutDir: true,
},
plugins: [react(),tsconfigPaths()],
})