npm - create-lupine - Versions diffs - 1.0.0 - Mend

create-lupine 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (62) hide show

package/templates/doc-starter/web/markdown/en/index.md ADDED Viewed

@@ -0,0 +1,42 @@
+---
+layout: home
+title: Doc Starter
+sidemenu-width: 260px
+github-title: View on GitHub
+github-link: https://github.com/uuware/lupine.js
+lang:
+  title: English
+  id: en
+hero:
+  name: Doc Starter
+  text: A Demo Documentation Project
+  tagline: This is a demo to show how to build documentation.
+  actions:
+    - theme: brand
+      text: Get Started
+      link: /en/guide/started
+    - theme: alt
+      text: View on GitHub
+      link: https://github.com/uuware/lupine.js
+nav:
+  - text: Guide
+    link: /en/guide/started
+  - text: API
+    link: /en/essentials/list
+sidebar:
+  - text: Guide
+    items:
+      - /en/guide/started
+      - /en/guide/install
+  - submenu: /en/essentials
+features:
+  - title: Demo Feature 1
+    details: This is a demo feature description.
+  - title: Demo Feature 2
+    details: This is another demo feature description.
+---

package/templates/doc-starter/web/markdown/index.md ADDED Viewed

@@ -0,0 +1,7 @@
+---
+lang:
+  - title: English
+    id: en
+  - title: 简体中文
+    id: zh
+---

package/templates/doc-starter/web/markdown/zh/essentials/index.md ADDED Viewed

@@ -0,0 +1,6 @@
+---
+sidebar:
+  - text: 核心要点
+    items:
+      - /zh/essentials/list
+---

package/templates/doc-starter/web/markdown/zh/essentials/list.md ADDED Viewed

@@ -0,0 +1,18 @@
+---
+title: 核心要点列表
+---
+> [!NOTE]
+> This is a demo document.
+# 核心要点列表
+This is a simplified essentials list doc for demo purposes.
+## 核心要点概述
+Here is an example listing key features:
+```tsx
+const features = ['Fast', 'Reliable', 'Easy to use'];
+```

package/templates/doc-starter/web/markdown/zh/guide/install.md ADDED Viewed

@@ -0,0 +1,18 @@
+---
+title: 安装
+---
+> [!NOTE]
+> This is a demo document.
+# 安装
+This is a simplified installation guide for demo purposes.
+## 基本安装
+Run the following command:
+```bash
+npm install my-project
+```

package/templates/doc-starter/web/markdown/zh/guide/started.md ADDED Viewed

@@ -0,0 +1,22 @@
+---
+title: 快速开始
+---
+> [!NOTE]
+> This is a demo document.
+# 简介
+This is a simplified getting started guide for demo purposes.
+## 快速开始
+Initialize your project:
+```javascript
+import { init } from 'my-project';
+init({
+  debug: true,
+});
+```

package/templates/doc-starter/web/markdown/zh/index.md ADDED Viewed

@@ -0,0 +1,42 @@
+---
+layout: home
+title: 文档演示
+sidemenu-width: 260px
+github-title: GitHub 仓库
+github-link: https://github.com/uuware/lupine.js
+lang:
+  title: 简体中文
+  id: zh
+hero:
+  name: 文档演示
+  text: 一个演示用的文档项目
+  tagline: 这是一个用来展示如何构建文档的演示项目。
+  actions:
+    - theme: brand
+      text: 快速开始
+      link: /zh/guide/started
+    - theme: alt
+      text: GitHub 仓库
+      link: https://github.com/uuware/lupine.js
+nav:
+  - text: 指南
+    link: /zh/guide/started
+  - text: API
+    link: /zh/essentials/list
+sidebar:
+  - text: 指南
+    items:
+      - /zh/guide/started
+      - /zh/guide/install
+  - submenu: /zh/essentials
+features:
+  - title: 演示特性 1
+    details: 这是一个演示特性的描述。
+  - title: 演示特性 2
+    details: 这是另一个演示特性的描述。
+---

package/templates/doc-starter/web/src/client-env-keys.ts ADDED Viewed

@@ -0,0 +1,5 @@
+export const enum ClientEnvKeys {
+  API_PORT = 'API_PORT',
+  API_BASE_URL = 'API_BASE_URL',
+  NODE_ENV = 'NODE_ENV',
+}

package/templates/doc-starter/web/src/index.html ADDED Viewed

@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html data-theme="<!--META-THEME-->">
+  <head>
+    <meta charset="utf-8" />
+    <link rel="manifest" href="{SUBDIR}/assets/site.webmanifest" />
+    <title><!--META-TITLE--></title>
+    <link rel="apple-touch-icon" sizes="180x180" href="{SUBDIR}/assets/apple-touch-icon.png" />
+    <link rel="icon" type="image/png" sizes="32x32" href="{SUBDIR}/assets/favicon-32x32.png" />
+    <link rel="icon" type="image/png" sizes="16x16" href="{SUBDIR}/assets/favicon-16x16.png" />
+    <link rel="icon" type="image/png" sizes="192x192" href="{SUBDIR}/assets/android-chrome-192x192.png" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <!--META-ENV-START-->
+    <!--META-ENV-END-->
+    <link rel="shortcut icon" href="{SUBDIR}/assets/favicon.ico?t={hash}" />
+    <link rel="stylesheet" type="text/css" href="{SUBDIR}/index.css?t={hash}" />
+    <script defer src="{SUBDIR}/index.js#t={hash}"></script>
+  </head>
+  <body>
+    <div class="lupine-root"></div>
+  </body>
+</html>

package/templates/doc-starter/web/src/index.tsx ADDED Viewed

@@ -0,0 +1,33 @@
+import {
+  bindRouter,
+  PageRouter,
+  bindTheme,
+  bindLang,
+  setDefaultPageTitle,
+  isFrontEnd,
+  debugWatch,
+  webEnv,
+  setDefaultMetaDescription,
+  bindGlobalStyle,
+} from 'lupine.components';
+import { bindPressData, PressPage, pressThemes } from 'lupine.press';
+import { markdownConfig } from './markdown-built/markdown-config';
+import { ClientEnvKeys } from './client-env-keys';
+import { baseCss } from './styles/base-css';
+if (isFrontEnd() && webEnv(ClientEnvKeys.NODE_ENV, '') === 'development') {
+  debugWatch(webEnv(ClientEnvKeys.API_PORT, 0));
+}
+bindLang('en', {});
+bindTheme('light', pressThemes);
+bindGlobalStyle('comm-css', baseCss, false, true);
+setDefaultPageTitle('LupineJS Doc');
+setDefaultMetaDescription('LupineJS Doc');
+bindPressData(markdownConfig);
+const pageRouter = new PageRouter();
+pageRouter.use('*', PressPage);
+bindRouter(pageRouter);

package/templates/doc-starter/web/src/markdown-built/en/essentials/index.html ADDED Viewed

File without changes

package/templates/doc-starter/web/src/markdown-built/en/essentials/list.html ADDED Viewed

@@ -0,0 +1,8 @@
+<blockquote>
+<p>[!NOTE]
+This is a demo document.</p>
+</blockquote>
+<h1 id="essentials-list"><a class="header-anchor" href="#essentials-list">#</a>Essentials List</h1><p>This is a simplified essentials list doc for demo purposes.</p>
+<h2 id="feature-overview"><a class="header-anchor" href="#feature-overview">#</a>Feature Overview</h2><p>Here is an example listing key features:</p>
+<pre><code class="language-tsx">const features = [&#39;Fast&#39;, &#39;Reliable&#39;, &#39;Easy to use&#39;];
+</code></pre>

package/templates/doc-starter/web/src/markdown-built/en/guide/install.html ADDED Viewed

@@ -0,0 +1,8 @@
+<blockquote>
+<p>[!NOTE]
+This is a demo document.</p>
+</blockquote>
+<h1 id="installation"><a class="header-anchor" href="#installation">#</a>Installation</h1><p>This is a simplified installation guide for demo purposes.</p>
+<h2 id="basic-install"><a class="header-anchor" href="#basic-install">#</a>Basic Install</h2><p>Run the following command:</p>
+<pre><code class="language-bash">npm install my-project
+</code></pre>

package/templates/doc-starter/web/src/markdown-built/en/guide/started.html ADDED Viewed

@@ -0,0 +1,12 @@
+<blockquote>
+<p>[!NOTE]
+This is a demo document.</p>
+</blockquote>
+<h1 id="getting-started"><a class="header-anchor" href="#getting-started">#</a>Getting Started</h1><p>This is a simplified getting started guide for demo purposes.</p>
+<h2 id="quick-start"><a class="header-anchor" href="#quick-start">#</a>Quick Start</h2><p>Initialize your project:</p>
+<pre><code class="language-javascript">import { init } from &#39;my-project&#39;;
+init({
+  debug: true,
+});
+</code></pre>

package/templates/doc-starter/web/src/markdown-built/en/index.html ADDED Viewed

File without changes

package/templates/doc-starter/web/src/markdown-built/index.html ADDED Viewed

File without changes

package/templates/doc-starter/web/src/markdown-built/markdown-config.ts ADDED Viewed

@@ -0,0 +1,25 @@
+import html0 from './index.html';
+import html1 from './en/essentials/index.html';
+import html2 from './en/essentials/list.html';
+import html3 from './en/guide/install.html';
+import html4 from './en/guide/started.html';
+import html5 from './en/index.html';
+import html6 from './zh/essentials/index.html';
+import html7 from './zh/essentials/list.html';
+import html8 from './zh/guide/install.html';
+import html9 from './zh/guide/started.html';
+import html10 from './zh/index.html';
+export const markdownConfig: Record<string, { html: string; data: any; headings: any[] }> = {
+  '/': { html: html0, data: {"lang":[{"title":"English","id":"en"},{"title":"简体中文","id":"zh"}]}, headings: [] },
+  '/en/essentials/index': { html: html1, data: {"title":"Core Essentials","sidebar":[{"type":"link","text":"Essentials List","link":"/en/essentials/list","level":0}]}, headings: [] },
+  '/en/essentials/list': { html: html2, data: {"title":"Essentials List"}, headings: [{"level":2,"text":"Feature Overview","id":"feature-overview"}] },
+  '/en/guide/install': { html: html3, data: {"title":"Installation"}, headings: [{"level":2,"text":"Basic Install","id":"basic-install"}] },
+  '/en/guide/started': { html: html4, data: {"title":"Getting Started"}, headings: [{"level":2,"text":"Quick Start","id":"quick-start"}] },
+  '/en/index': { html: html5, data: {"layout":"home","title":"Doc Starter","sidemenu-width":"260px","github-title":"View on GitHub","github-link":"https://github.com/uuware/lupine.js","lang":{"title":"English","id":"en"},"hero":{"name":"Doc Starter","text":"A Demo Documentation Project","tagline":"This is a demo to show how to build documentation.","actions":[{"theme":"brand","text":"Get Started","link":"/en/guide/started"},{"theme":"alt","text":"View on GitHub","link":"https://github.com/uuware/lupine.js"}]},"nav":[{"text":"Guide","link":"/en/guide/started"},{"text":"API","link":"/en/essentials/list"}],"sidebar":[{"type":"group","text":"Guide","level":0},{"type":"link","text":"Getting Started","link":"/en/guide/started","level":1},{"type":"link","text":"Installation","link":"/en/guide/install","level":1},{"type":"group","text":"Core Essentials","level":0},{"type":"link","text":"Essentials List","link":"/en/essentials/list","level":1}],"features":[{"title":"Demo Feature 1","details":"This is a demo feature description."},{"title":"Demo Feature 2","details":"This is another demo feature description."}]}, headings: [] },
+  '/zh/essentials/index': { html: html6, data: {"sidebar":[{"type":"group","text":"核心要点","level":0},{"type":"link","text":"核心要点列表","link":"/zh/essentials/list","level":1}]}, headings: [] },
+  '/zh/essentials/list': { html: html7, data: {"title":"核心要点列表"}, headings: [{"level":2,"text":"核心要点概述","id":"核心要点概述"}] },
+  '/zh/guide/install': { html: html8, data: {"title":"安装"}, headings: [{"level":2,"text":"基本安装","id":"基本安装"}] },
+  '/zh/guide/started': { html: html9, data: {"title":"快速开始"}, headings: [{"level":2,"text":"快速开始","id":"快速开始"}] },
+  '/zh/index': { html: html10, data: {"layout":"home","title":"文档演示","sidemenu-width":"260px","github-title":"GitHub 仓库","github-link":"https://github.com/uuware/lupine.js","lang":{"title":"简体中文","id":"zh"},"hero":{"name":"文档演示","text":"一个演示用的文档项目","tagline":"这是一个用来展示如何构建文档的演示项目。","actions":[{"theme":"brand","text":"快速开始","link":"/zh/guide/started"},{"theme":"alt","text":"GitHub 仓库","link":"https://github.com/uuware/lupine.js"}]},"nav":[{"text":"指南","link":"/zh/guide/started"},{"text":"API","link":"/zh/essentials/list"}],"sidebar":[{"type":"group","text":"指南","level":0},{"type":"link","text":"快速开始","link":"/zh/guide/started","level":1},{"type":"link","text":"安装","link":"/zh/guide/install","level":1},{"type":"group","text":"核心要点","level":0},{"type":"link","text":"核心要点列表","link":"/zh/essentials/list","level":1}],"features":[{"title":"演示特性 1","details":"这是一个演示特性的描述。"},{"title":"演示特性 2","details":"这是另一个演示特性的描述。"}]}, headings: [] },
+};

package/templates/doc-starter/web/src/markdown-built/zh/essentials/index.html ADDED Viewed

File without changes

package/templates/doc-starter/web/src/markdown-built/zh/essentials/list.html ADDED Viewed

@@ -0,0 +1,8 @@
+<blockquote>
+<p>[!NOTE]
+This is a demo document.</p>
+</blockquote>
+<h1 id="核心要点列表"><a class="header-anchor" href="#核心要点列表">#</a>核心要点列表</h1><p>This is a simplified essentials list doc for demo purposes.</p>
+<h2 id="核心要点概述"><a class="header-anchor" href="#核心要点概述">#</a>核心要点概述</h2><p>Here is an example listing key features:</p>
+<pre><code class="language-tsx">const features = [&#39;Fast&#39;, &#39;Reliable&#39;, &#39;Easy to use&#39;];
+</code></pre>

package/templates/doc-starter/web/src/markdown-built/zh/guide/install.html ADDED Viewed

@@ -0,0 +1,8 @@
+<blockquote>
+<p>[!NOTE]
+This is a demo document.</p>
+</blockquote>
+<h1 id="安装"><a class="header-anchor" href="#安装">#</a>安装</h1><p>This is a simplified installation guide for demo purposes.</p>
+<h2 id="基本安装"><a class="header-anchor" href="#基本安装">#</a>基本安装</h2><p>Run the following command:</p>
+<pre><code class="language-bash">npm install my-project
+</code></pre>

package/templates/doc-starter/web/src/markdown-built/zh/guide/started.html ADDED Viewed

@@ -0,0 +1,12 @@
+<blockquote>
+<p>[!NOTE]
+This is a demo document.</p>
+</blockquote>
+<h1 id="简介"><a class="header-anchor" href="#简介">#</a>简介</h1><p>This is a simplified getting started guide for demo purposes.</p>
+<h2 id="快速开始"><a class="header-anchor" href="#快速开始">#</a>快速开始</h2><p>Initialize your project:</p>
+<pre><code class="language-javascript">import { init } from &#39;my-project&#39;;
+init({
+  debug: true,
+});
+</code></pre>

package/templates/doc-starter/web/src/markdown-built/zh/index.html ADDED Viewed

File without changes

package/templates/doc-starter/web/src/styles/base-css.ts ADDED Viewed

@@ -0,0 +1,15 @@
+export const baseCss = {
+  a: {
+    textDecoration: 'none',
+    color: 'inherit',
+    '&:hover': { color: 'var(--press-brand-color)' },
+  },
+  body: {
+    backgroundColor: 'var(--primary-bg-color)',
+    color: 'var(--primary-color)',
+    fontSize: 'var(--font-size-base)',
+    lineHeight: 'var(--line-height-base)',
+    fontFamily: 'var(--font-family-base)',
+    fontWeight: 'var(--font-weight-base)',
+  },
+};

package/templates/hello-world/api/resources/config_default.json ADDED Viewed

@@ -0,0 +1,6 @@
+{
+  "WEB.pageLimit": "15",
+  "WEB.siteTitle": "Sample title",
+  "WEB.siteEmail": "sample@sample.com",
+  "WEB.siteUrl": "https://sample.com"
+}

package/templates/hello-world/api/resources/install.sqlite.sql ADDED Viewed

@@ -0,0 +1,4 @@
+#-- sql queries to create tables
+#-- Never name a table with plural (such as "users")
+#-- Never name a table using a reserved keyword (such as "user")
+#-- Never prefix your table name with "tbl" or some other object type prefix

package/templates/hello-world/api/src/index.ts ADDED Viewed

@@ -0,0 +1,4 @@
+import { ApiModule } from 'lupine.api';
+import { RootApi } from './service/root-api';
+export const apiModule = new ApiModule(new RootApi());

package/templates/hello-world/api/src/service/root-api.ts ADDED Viewed

@@ -0,0 +1,18 @@
+import { IApiBase, StaticServer, ApiRouter } from 'lupine.api';
+export class RootApi implements IApiBase {
+  protected router = new ApiRouter();
+  constructor() {
+    this.mountDashboard();
+  }
+  public getRouter(): ApiRouter {
+    return this.router;
+  }
+  protected mountDashboard() {
+    const staticServer = new StaticServer();
+    this.router.use('*', staticServer.processRequest.bind(staticServer));
+  }
+}

package/templates/hello-world/lupine.json ADDED Viewed

@@ -0,0 +1,23 @@
+{
+  "name": "hello-world",
+  "webEntryPoints": [
+    {
+      "index": "web/src/index.tsx",
+      "html": "web/src/index.html",
+      "outdir": "/"
+    }
+  ],
+  "apiEntryPoint": "api/src/index.ts",
+  "copyFiles": [
+    {
+      "type": "web",
+      "from": "web/assets",
+      "to": "assets"
+    },
+    {
+      "type": "data",
+      "from": "api/resources",
+      "to": "resources"
+    }
+  ]
+}

package/templates/hello-world/web/assets/favicon.ico ADDED Viewed

Binary file

package/templates/hello-world/web/package.json ADDED Viewed

@@ -0,0 +1,6 @@
+{
+  "name": "hello-world-web",
+  "version": "1.0.0",
+  "dependencies": {},
+  "devDependencies": {}
+}

package/templates/hello-world/web/src/index.html ADDED Viewed

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html data-theme="<!--META-THEME-->">
+  <head>
+    <meta charset="utf-8" />
+    <title><!--META-TITLE--></title>
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <!--META-ENV-START-->
+    <!--META-ENV-END-->
+    <link rel="shortcut icon" href="{SUBDIR}/assets/favicon.ico?t={hash}" />
+    <link rel="stylesheet" type="text/css" href="{SUBDIR}/index.css?t={hash}" />
+    <script defer src="{SUBDIR}/index.js#t={hash}"></script>
+  </head>
+  <body>
+    <div class="lupine-root"></div>
+  </body>
+</html>

package/templates/hello-world/web/src/index.tsx ADDED Viewed

@@ -0,0 +1,30 @@
+import { bindRouter, CssProps, debugWatch, HtmlVar, isFrontEnd, PageRouter, webEnv } from 'lupine.components';
+const HelloPage = () => {
+  const css: CssProps = {
+    padding: '20px',
+    h1: {
+      color: 'blue',
+      '&:hover': {
+        color: 'red',
+      },
+    },
+  };
+  const dom = new HtmlVar('0');
+  return (
+    <div css={css} style={{ textAlign: 'center' }}>
+      <h1>Hello World</h1>
+      <p>This is a simplified Lupine.js project.</p>
+      <p>{dom.node}</p>
+      <button onClick={() => (dom.value = (Number(dom.value) + 1).toString())}>Increment</button>
+    </div>
+  );
+};
+if (isFrontEnd() && webEnv('NODE_ENV', '') === 'development') {
+  debugWatch(webEnv('API_PORT', 0));
+}
+const pageRouter = new PageRouter();
+pageRouter.use('/', HelloPage);
+bindRouter(pageRouter);