[backend/frontend/shared] server-side plugins and basic spa frontend
feat(backend): finish server-side plugin system feat(frontend): implement basic frontend with typescript, vite, vue and vue-router feat(shared/plugins): implement example-plugin, to showcase the server-side plugin implementation feat(shared/plugins): implement base file-structure for client-side plugins
This commit is contained in:
parent
20cdba55f6
commit
0db7875bc1
31 changed files with 369 additions and 30 deletions
|
@ -3,7 +3,9 @@
|
|||
<component name="MaterialThemeProjectNewConfig">
|
||||
<option name="metadata">
|
||||
<MTProjectMetadataState>
|
||||
<option name="userId" value="-32c605a5:19059151b4d:-7da1" />
|
||||
<option name="migrated" value="true" />
|
||||
<option name="pristineConfig" value="false" />
|
||||
<option name="userId" value="-2b035df3:18ee689acec:-8000" />
|
||||
</MTProjectMetadataState>
|
||||
</option>
|
||||
</component>
|
||||
|
|
|
@ -16,6 +16,7 @@
|
|||
"@nestjs/core": "^10.0.0",
|
||||
"@nestjs/platform-express": "^10.0.0",
|
||||
"@nestjs/typeorm": "^10.0.1",
|
||||
"ascii-table": "^0.0.9",
|
||||
"glob": "^10.4.2",
|
||||
"mongodb": "^6.7.0",
|
||||
"pg": "^8.11.3",
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
import { Module, type Type } from '@nestjs/common';
|
||||
import { Module } from '@nestjs/common';
|
||||
import { TypeOrmModule } from '@nestjs/typeorm';
|
||||
import { User } from './entities/user.entity';
|
||||
import { PluginModule } from "./common/plugins/plugin.module";
|
||||
|
|
|
@ -1,5 +1,3 @@
|
|||
import {INestApplication} from "@nestjs/common";
|
||||
|
||||
export interface Plugin {
|
||||
register(app: INestApplication): void
|
||||
register(): void
|
||||
}
|
|
@ -1,9 +1,9 @@
|
|||
import { glob } from 'glob';
|
||||
import { join } from 'path';
|
||||
|
||||
export async function loadPlugins(): Promise<unknown> {
|
||||
export async function loadPlugins(): Promise<any[]> {
|
||||
return new Promise(async (resolve, reject) => {
|
||||
const files = await glob('homespace-shared/plugins/**/*.plugin.{ts,js}');
|
||||
const files = await glob('../shared/plugins/**/*.plugin.{ts,js}');
|
||||
|
||||
console.log(files)
|
||||
|
||||
|
|
|
@ -1,6 +1,5 @@
|
|||
import { Module, DynamicModule, Global, type Type } from '@nestjs/common';
|
||||
import { Module, DynamicModule, Global } from '@nestjs/common';
|
||||
import { PluginService } from './plugin.service';
|
||||
import { type Plugin } from './plugin.interface';
|
||||
import { loadPlugins } from './plugin.loader';
|
||||
|
||||
@Global()
|
||||
|
@ -9,8 +8,14 @@ export class PluginModule {
|
|||
static async register(): Promise<DynamicModule> {
|
||||
const plugins = await loadPlugins();
|
||||
|
||||
const pluginModules = plugins.map(pluginClass => {
|
||||
const pluginInstance = new pluginClass();
|
||||
return pluginInstance.getModule();
|
||||
})
|
||||
|
||||
return {
|
||||
module: PluginModule,
|
||||
imports: [...pluginModules],
|
||||
providers: [
|
||||
PluginService,
|
||||
...plugins,
|
||||
|
|
|
@ -1,18 +1,14 @@
|
|||
import {Injectable, OnModuleInit, Inject, type Type, INestApplication} from '@nestjs/common';
|
||||
import { Injectable, OnModuleInit, Inject, type Type } from '@nestjs/common';
|
||||
import { type Plugin } from './plugin.interface';
|
||||
|
||||
@Injectable()
|
||||
export class PluginService {
|
||||
private plugins: Type<Plugin>[] = [];
|
||||
export class PluginService implements OnModuleInit {
|
||||
constructor(@Inject('PLUGIN_PROVIDERS') private readonly pluginProviders: Type<Plugin>[]) {}
|
||||
|
||||
constructor(@Inject('PLUGIN_PROVIDERS') private readonly pluginProviders: Type<Plugin>[]) {
|
||||
this.plugins = pluginProviders;
|
||||
}
|
||||
|
||||
initializePlugins(app: INestApplication) {
|
||||
this.plugins.forEach(plugin => {
|
||||
onModuleInit() {
|
||||
this.pluginProviders.forEach(plugin => {
|
||||
const pluginInstance = new plugin();
|
||||
pluginInstance.register(app);
|
||||
pluginInstance.register();
|
||||
});
|
||||
}
|
||||
}
|
|
@ -1,13 +1,9 @@
|
|||
import { NestFactory } from '@nestjs/core';
|
||||
import { AppModule } from './app.module';
|
||||
import { PluginService } from "./common/plugins/plugin.service";
|
||||
|
||||
async function bootstrap() {
|
||||
const app = await NestFactory.create(AppModule);
|
||||
|
||||
const pluginService = app.get(PluginService);
|
||||
pluginService.initializePlugins(app);
|
||||
|
||||
await app.listen(4300);
|
||||
}
|
||||
|
||||
|
|
4
apps/frontend/.env.development
Normal file
4
apps/frontend/.env.development
Normal file
|
@ -0,0 +1,4 @@
|
|||
# .env.development
|
||||
VITE_APP_TITLE=HomeSpace
|
||||
VITE_APP_DESC='The HomeSpace project'
|
||||
VITE_APP_URL=http://localhost:5173/
|
4
apps/frontend/.env.production
Normal file
4
apps/frontend/.env.production
Normal file
|
@ -0,0 +1,4 @@
|
|||
# .env.production
|
||||
VITE_APP_TITLE=HomeSpace
|
||||
VITE_APP_DESC='The HomeSpace project'
|
||||
VITE_APP_URL=https://homespace.thevoid.cafe
|
25
apps/frontend/.gitignore
vendored
Normal file
25
apps/frontend/.gitignore
vendored
Normal file
|
@ -0,0 +1,25 @@
|
|||
# Logs
|
||||
logs
|
||||
*.log
|
||||
npm-debug.log*
|
||||
yarn-debug.log*
|
||||
yarn-error.log*
|
||||
pnpm-debug.log*
|
||||
lerna-debug.log*
|
||||
|
||||
node_modules
|
||||
dist
|
||||
dist-ssr
|
||||
*.local
|
||||
|
||||
# Editor directories and files
|
||||
.vscode/*
|
||||
!.vscode/extensions.json
|
||||
!.vscode/tasks.json
|
||||
.idea
|
||||
.DS_Store
|
||||
*.suo
|
||||
*.ntvs*
|
||||
*.njsproj
|
||||
*.sln
|
||||
*.sw?
|
18
apps/frontend/index.html
Normal file
18
apps/frontend/index.html
Normal file
|
@ -0,0 +1,18 @@
|
|||
<!doctype html>
|
||||
<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_APP_TITLE%</title>
|
||||
<meta property="og:title" content="%VITE_APP_TITLE%" />
|
||||
<meta property="og:description" content="%VITE_APP_DESC%" />
|
||||
<meta property="og:type" content="website" />
|
||||
<meta property="og:url" content="%VITE_APP_URL" />
|
||||
<meta property="og:image" content="%VITE_APP_TITLE%/vite.png" />
|
||||
</head>
|
||||
<body>
|
||||
<div id="app"></div>
|
||||
<script type="module" src="./src/main.ts"></script>
|
||||
</body>
|
||||
</html>
|
|
@ -1,4 +1,22 @@
|
|||
{
|
||||
"name": "homespace-frontend",
|
||||
"version": "0.0.1"
|
||||
"private": true,
|
||||
"version": "0.0.1",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"dev": "vite",
|
||||
"build": "vue-tsc && vite build",
|
||||
"preview": "vite preview"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/node": "^20.14.9",
|
||||
"@vitejs/plugin-vue": "^5.0.5",
|
||||
"typescript": "^5.5.2",
|
||||
"vite": "^5.3.2",
|
||||
"vue-tsc": "^2.0.22"
|
||||
},
|
||||
"dependencies": {
|
||||
"vue": "^3.4.31",
|
||||
"vue-router": "^4.4.0"
|
||||
}
|
||||
}
|
BIN
apps/frontend/public/vite.png
Normal file
BIN
apps/frontend/public/vite.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 13 KiB |
1
apps/frontend/public/vite.svg
Normal file
1
apps/frontend/public/vite.svg
Normal file
|
@ -0,0 +1 @@
|
|||
<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>
|
After Width: | Height: | Size: 1.5 KiB |
13
apps/frontend/src/App.vue
Normal file
13
apps/frontend/src/App.vue
Normal file
|
@ -0,0 +1,13 @@
|
|||
<template>
|
||||
<h1>Hello App!</h1>
|
||||
<p>
|
||||
<strong>Current route path:</strong> {{ $route.fullPath }}
|
||||
</p>
|
||||
<nav>
|
||||
<RouterLink to="/">Go to Home</RouterLink>
|
||||
<RouterLink to="/about">Go to About</RouterLink>
|
||||
</nav>
|
||||
<main>
|
||||
<RouterView />
|
||||
</main>
|
||||
</template>
|
1
apps/frontend/src/assets/vue.svg
Normal file
1
apps/frontend/src/assets/vue.svg
Normal file
|
@ -0,0 +1 @@
|
|||
<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="37.07" height="36" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 198"><path fill="#41B883" d="M204.8 0H256L128 220.8L0 0h97.92L128 51.2L157.44 0h47.36Z"></path><path fill="#41B883" d="m0 0l128 220.8L256 0h-51.2L128 132.48L50.56 0H0Z"></path><path fill="#35495E" d="M50.56 0L128 133.12L204.8 0h-47.36L128 51.2L97.92 0H50.56Z"></path></svg>
|
After Width: | Height: | Size: 496 B |
38
apps/frontend/src/components/HelloWorld.vue
Normal file
38
apps/frontend/src/components/HelloWorld.vue
Normal file
|
@ -0,0 +1,38 @@
|
|||
<script setup lang="ts">
|
||||
import { ref } from 'vue'
|
||||
|
||||
defineProps<{ msg: string }>()
|
||||
|
||||
const count = ref(0)
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<h1>{{ msg }}</h1>
|
||||
|
||||
<div class="card">
|
||||
<button type="button" @click="count++">count is {{ count }}</button>
|
||||
<p>
|
||||
Edit
|
||||
<code>components/HelloWorld.vue</code> to test HMR
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<p>
|
||||
Check out
|
||||
<a href="https://vuejs.org/guide/quick-start.html#local" target="_blank"
|
||||
>create-vue</a
|
||||
>, the official Vue + Vite starter
|
||||
</p>
|
||||
<p>
|
||||
Install
|
||||
<a href="https://github.com/vuejs/language-tools" target="_blank">Volar</a>
|
||||
in your IDE for a better DX
|
||||
</p>
|
||||
<p class="read-the-docs">Click on the Vite and Vue logos to learn more</p>
|
||||
</template>
|
||||
|
||||
<style scoped>
|
||||
.read-the-docs {
|
||||
color: #888;
|
||||
}
|
||||
</style>
|
8
apps/frontend/src/main.ts
Normal file
8
apps/frontend/src/main.ts
Normal file
|
@ -0,0 +1,8 @@
|
|||
import { createApp } from 'vue'
|
||||
import './style.css'
|
||||
import App from './App.vue'
|
||||
import { router } from './router.ts';
|
||||
|
||||
createApp(App)
|
||||
.use(router)
|
||||
.mount('#app')
|
14
apps/frontend/src/router.ts
Normal file
14
apps/frontend/src/router.ts
Normal file
|
@ -0,0 +1,14 @@
|
|||
import { createWebHistory, createRouter } from 'vue-router'
|
||||
|
||||
import HomeView from './routes/HomeView.vue'
|
||||
import AboutView from './routes/AboutView.vue'
|
||||
|
||||
const routes = [
|
||||
{ path: '/', component: HomeView },
|
||||
{ path: '/about', component: AboutView },
|
||||
]
|
||||
|
||||
export const router = createRouter({
|
||||
history: createWebHistory(),
|
||||
routes,
|
||||
})
|
6
apps/frontend/src/routes/AboutView.vue
Normal file
6
apps/frontend/src/routes/AboutView.vue
Normal file
|
@ -0,0 +1,6 @@
|
|||
<script setup lang="ts">
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<h1>About</h1>
|
||||
</template>
|
6
apps/frontend/src/routes/HomeView.vue
Normal file
6
apps/frontend/src/routes/HomeView.vue
Normal file
|
@ -0,0 +1,6 @@
|
|||
<script setup lang="ts">
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<h1>Home</h1>
|
||||
</template>
|
79
apps/frontend/src/style.css
Normal file
79
apps/frontend/src/style.css
Normal file
|
@ -0,0 +1,79 @@
|
|||
:root {
|
||||
font-family: Inter, system-ui, Avenir, Helvetica, Arial, sans-serif;
|
||||
line-height: 1.5;
|
||||
font-weight: 400;
|
||||
|
||||
color-scheme: light dark;
|
||||
color: rgba(255, 255, 255, 0.87);
|
||||
background-color: #242424;
|
||||
|
||||
font-synthesis: none;
|
||||
text-rendering: optimizeLegibility;
|
||||
-webkit-font-smoothing: antialiased;
|
||||
-moz-osx-font-smoothing: grayscale;
|
||||
}
|
||||
|
||||
a {
|
||||
font-weight: 500;
|
||||
color: #646cff;
|
||||
text-decoration: inherit;
|
||||
}
|
||||
a:hover {
|
||||
color: #535bf2;
|
||||
}
|
||||
|
||||
body {
|
||||
margin: 0;
|
||||
display: flex;
|
||||
place-items: center;
|
||||
min-width: 320px;
|
||||
min-height: 100vh;
|
||||
}
|
||||
|
||||
h1 {
|
||||
font-size: 3.2em;
|
||||
line-height: 1.1;
|
||||
}
|
||||
|
||||
button {
|
||||
border-radius: 8px;
|
||||
border: 1px solid transparent;
|
||||
padding: 0.6em 1.2em;
|
||||
font-size: 1em;
|
||||
font-weight: 500;
|
||||
font-family: inherit;
|
||||
background-color: #1a1a1a;
|
||||
cursor: pointer;
|
||||
transition: border-color 0.25s;
|
||||
}
|
||||
button:hover {
|
||||
border-color: #646cff;
|
||||
}
|
||||
button:focus,
|
||||
button:focus-visible {
|
||||
outline: 4px auto -webkit-focus-ring-color;
|
||||
}
|
||||
|
||||
.card {
|
||||
padding: 2em;
|
||||
}
|
||||
|
||||
#app {
|
||||
max-width: 1280px;
|
||||
margin: 0 auto;
|
||||
padding: 2rem;
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
@media (prefers-color-scheme: light) {
|
||||
:root {
|
||||
color: #213547;
|
||||
background-color: #ffffff;
|
||||
}
|
||||
a:hover {
|
||||
color: #747bff;
|
||||
}
|
||||
button {
|
||||
background-color: #f9f9f9;
|
||||
}
|
||||
}
|
1
apps/frontend/src/vite-env.d.ts
vendored
Normal file
1
apps/frontend/src/vite-env.d.ts
vendored
Normal file
|
@ -0,0 +1 @@
|
|||
/// <reference types="vite/client" />
|
25
apps/frontend/tsconfig.json
Normal file
25
apps/frontend/tsconfig.json
Normal file
|
@ -0,0 +1,25 @@
|
|||
{
|
||||
"compilerOptions": {
|
||||
"target": "ES2020",
|
||||
"useDefineForClassFields": true,
|
||||
"module": "ESNext",
|
||||
"lib": ["ES2020", "DOM", "DOM.Iterable"],
|
||||
"skipLibCheck": true,
|
||||
|
||||
/* Bundler mode */
|
||||
"moduleResolution": "bundler",
|
||||
"allowImportingTsExtensions": true,
|
||||
"resolveJsonModule": true,
|
||||
"isolatedModules": true,
|
||||
"noEmit": true,
|
||||
"jsx": "preserve",
|
||||
|
||||
/* Linting */
|
||||
"strict": true,
|
||||
"noUnusedLocals": true,
|
||||
"noUnusedParameters": true,
|
||||
"noFallthroughCasesInSwitch": true
|
||||
},
|
||||
"include": ["src/**/*.ts", "src/**/*.tsx", "src/**/*.vue"],
|
||||
"references": [{ "path": "./tsconfig.node.json" }]
|
||||
}
|
17
apps/frontend/tsconfig.node.json
Normal file
17
apps/frontend/tsconfig.node.json
Normal file
|
@ -0,0 +1,17 @@
|
|||
{
|
||||
"compilerOptions": {
|
||||
"composite": true,
|
||||
"skipLibCheck": true,
|
||||
"module": "ESNext",
|
||||
"moduleResolution": "bundler",
|
||||
"allowSyntheticDefaultImports": true,
|
||||
/* Paths */
|
||||
"baseUrl": ".",
|
||||
"paths": {
|
||||
"@/*": ["./src/*"]
|
||||
}
|
||||
},
|
||||
"include": [
|
||||
"vite.config.ts"
|
||||
]
|
||||
}
|
13
apps/frontend/vite.config.ts
Normal file
13
apps/frontend/vite.config.ts
Normal file
|
@ -0,0 +1,13 @@
|
|||
import { defineConfig } from 'vite'
|
||||
import vue from '@vitejs/plugin-vue'
|
||||
import path from 'node:path'
|
||||
|
||||
// https://vitejs.dev/config/
|
||||
export default defineConfig({
|
||||
resolve: {
|
||||
alias: {
|
||||
'@': path.resolve(__dirname, './src')
|
||||
}
|
||||
},
|
||||
plugins: [vue()]
|
||||
})
|
|
@ -1,8 +1,38 @@
|
|||
// Todo: create example plugin
|
||||
import { type Plugin } from "homespace-backend/src/common/plugins/plugin.interface";
|
||||
import { type Plugin } from 'homespace-backend/src/common/plugins/plugin.interface';
|
||||
import { Injectable, Controller, Get, Module, Logger } from '@nestjs/common';
|
||||
|
||||
export class ExamplePlugin implements Plugin {
|
||||
register() {
|
||||
console.log("plugin registered: ExamplePlugin");
|
||||
// Service
|
||||
@Injectable()
|
||||
class ExampleService {
|
||||
getData(): { plugin: string } {
|
||||
return { plugin: "example-plugin" };
|
||||
}
|
||||
}
|
||||
|
||||
// Controller
|
||||
@Controller('example')
|
||||
class ExampleController {
|
||||
constructor(private readonly exampleService: ExampleService) {}
|
||||
|
||||
@Get()
|
||||
getExampleData(): { plugin: string } {
|
||||
return this.exampleService.getData();
|
||||
}
|
||||
}
|
||||
|
||||
// Plugin
|
||||
export class ExamplePlugin implements Plugin {
|
||||
getModule() {
|
||||
@Module({
|
||||
controllers: [ExampleController],
|
||||
providers: [ExampleService],
|
||||
})
|
||||
class ExampleModule {}
|
||||
|
||||
return ExampleModule;
|
||||
}
|
||||
|
||||
register(): void {
|
||||
Logger.log('Example Plugin Registered', 'ExamplePlugin');
|
||||
}
|
||||
}
|
20
apps/shared/plugins/example-plugin/tsconfig.json
Normal file
20
apps/shared/plugins/example-plugin/tsconfig.json
Normal file
|
@ -0,0 +1,20 @@
|
|||
{
|
||||
"compilerOptions": {
|
||||
"module": "commonjs",
|
||||
"declaration": true,
|
||||
"removeComments": true,
|
||||
"emitDecoratorMetadata": true,
|
||||
"experimentalDecorators": true,
|
||||
"allowSyntheticDefaultImports": true,
|
||||
"target": "ES2021",
|
||||
"sourceMap": true,
|
||||
"baseUrl": "./",
|
||||
"incremental": true,
|
||||
"skipLibCheck": true,
|
||||
"strictNullChecks": false,
|
||||
"noImplicitAny": false,
|
||||
"strictBindCallApply": false,
|
||||
"forceConsistentCasingInFileNames": false,
|
||||
"noFallthroughCasesInSwitch": false
|
||||
}
|
||||
}
|
BIN
bun.lockb
BIN
bun.lockb
Binary file not shown.
Loading…
Reference in a new issue