@venizia/ignis-docs 0.0.2 → 0.0.4-0

package/wiki/index.md

@@ -1,48 +1,187 @@
 ---
-# https://vitepress.dev/reference/default-theme-home-page
 layout: home
 
 hero:
-  name: "🔥 IGNIS"
-  text: "A TypeScript Server Infrastructure with Hono"
-  tagline: Enterprise-grade architecture meets Hono's ultrafast performance. Build scalable REST APIs with TypeScript.
+  name: IGNIS
+  text: Enterprise APIs at Hono Speed
+  tagline: "Architecture that scales, performance that flies. Enterprise patterns, raw performance speed, DI Powered."
+  image:
+    src: /logo.svg
+    alt: IGNIS
   actions:
     - theme: brand
       text: Get Started
-      link: /get-started/
+      link: /guides/get-started/5-minute-quickstart
     - theme: alt
-      text: Quickstart
-      link: /get-started/quickstart
+      text: Why Ignis?
+      link: /guides/get-started/philosophy
     - theme: alt
-      text: Philosophy
-      link: /get-started/philosophy
+      text: GitHub
+      link: https://github.com/VENIZIA-AI/ignis
 
 features:
-  - icon: <svg width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-zap"><polygon points="13 2 3 14 12 14 11 22 21 10 12 10 13 2"></polygon></svg>
-    title: Ultrafast Hono Performance
-    details: Leverage Hono's speed for high-performance APIs and serverless environments, ensuring your applications are always responsive.
-
-  - icon: <svg width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-git-branch"><line x1="6" y1="3" x2="6" y2="15"></line><path d="M18 6l-6 6-6-6"></path><path d="M12 18V6"></path><path d="M18 12l-6 6-6-6"></path><circle cx="6" cy="18" r="3"></circle><circle cx="18" cy="6" r="3"></circle></svg>
-    title: Modular Package Architecture
-    details: Built as a monorepo with independent packages (@venizia/ignis, @venizia/ignis-helpers, @venizia/ignis-inversion, @venizia/dev-configs) for flexible, granular consumption.
-
-  - icon: <svg width="24" height="24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-share-2"><circle cx="18" cy="6" r="3"></circle><circle cx="6" cy="12" r="3"></circle><circle cx="18" cy="18" r="3"></circle><line x1="8.59" y1="13.51" x2="15.42" y2="16.49"></line><line x1="15.41" y1="7.51" x2="8.59" y2="10.49"></line></svg>
-    title: Powerful Dependency Injection
-    details: Utilize a custom, lightweight DI container to promote loose coupling, enhanced testability, and flexible code organization.
-
-  - icon: <svg width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-layers"><polygon points="12 2 2 7 12 12 22 7 12 2"></polygon><polyline points="2 17 12 22 22 17"></polyline><polyline points="2 12 12 17 22 12"></polyline></svg>
-    title: Clear Layered Architecture
-    details: Organize your code with a strict separation of concerns (Controllers, Services, Repositories) for maintainability and clarity.
-
-  - icon: <svg width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-book-open"><path d="M2 3h6a4 4 0 0 1 4 4v14a3 3 0 0 0-3-3H2z"></path><path d="M22 3h-6a4 4 0 0 0-4 4v14a3 3 0 0 1 3-3h7z"></path></svg>
-    title: Automated OpenAPI Documentation
-    details: Generate interactive Swagger UI documentation effortlessly from your Zod schemas, simplifying API consumption and understanding.
-
-  - icon: <svg width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-tool"><path d="M14.7 6.3a1 1 0 0 0 0 1.4l1.6 1.6a1 1 0 0 0 1.4 0l3.77-3.77a6 6 0 0 1-7.94 7.94l-2.06 2.06A7.5 7.5 0 0 1 1.07 11.24a7.5 7.5 0 0 1 10.6-10.6z"></path></svg>
-    title: Rich & Extensible Ecosystem
-    details: Benefit from comprehensive built-in helpers for Authentication, Logging, Database interactions, Queues, Worker Threads, and more.
-
-footer:
-  message: Released under the MIT License.
-  copyright: Copyright © 2024-present VENIZIA-AI
----
+  - icon: ⚡
+    title: 140k+ req/s
+    details: Built on Hono, one of the fastest web frameworks. Near-native performance on Bun, Node, and edge runtimes.
+    link: /guides/get-started/philosophy
+    linkText: See benchmarks
+
+  - icon: 🏗️
+    title: Enterprise Architecture
+    details: Layered design with Controllers, Services, and Repositories. Clean separation of concerns out of the box.
+    link: /guides/core-concepts/application/
+    linkText: Learn more
+
+  - icon: 💉
+    title: Dependency Injection
+    details: Lightweight DI container with decorators. Testable, loosely coupled code without the boilerplate.
+    link: /guides/core-concepts/dependency-injection
+    linkText: See how
+
+  - icon: 📝
+    title: Auto-Generated Docs
+    details: OpenAPI/Swagger from Zod schemas. Interactive API explorer included with zero config.
+    link: /references/components/swagger
+    linkText: View example
+
+  - icon: 🗃️
+    title: Type-Safe Database
+    details: Drizzle ORM integration with advanced filtering, relations, JSON queries, and transactions.
+    link: /references/base/repositories/
+    linkText: Explore
+
+  - icon: 🧩
+    title: Batteries Included
+    details: Auth, WebSockets, Queues, Cron, Redis, S3, Email — ready-to-use components and helpers.
+    link: /references/
+    linkText: Browse all
+---
+
+
+
+## Quick Start
+
+```bash
+# Install dependencies
+bun add hono @hono/zod-openapi @scalar/hono-api-reference @venizia/ignis
+bun add -d typescript @types/bun
+
+# Create src/index.ts with your first API
+```
+
+```typescript
+import { BaseApplication, BaseController, controller, get, HTTP, jsonContent, SwaggerComponent } from '@venizia/ignis';
+import { z } from '@hono/zod-openapi';
+
+// 1. Define your controller
+@controller({ path: '/hello' })
+class HelloController extends BaseController {
+  constructor() {
+    super({ scope: 'HelloController', path: '/hello' });
+  }
+
+  override binding() {} // Required: register additional routes or dependencies here
+
+  @get({
+    configs: {
+      path: '/',
+      responses: {
+        [HTTP.ResultCodes.RS_2.Ok]: jsonContent({
+          schema: z.object({ message: z.string() }),
+        }),
+      },
+    },
+  })
+  sayHello(c) {
+    return c.json({ message: 'Hello from Ignis! 🔥' });
+  }
+}
+
+// 2. Create and configure your application
+class App extends BaseApplication {
+  getAppInfo() {
+    return { name: 'my-app', version: '1.0.0', description: 'My Ignis App' };
+  }
+  staticConfigure() {}
+  preConfigure() {
+    this.component(SwaggerComponent);  // API docs at /doc/explorer
+    this.controller(HelloController);
+  }
+  postConfigure() {}
+  setupMiddlewares() {}
+}
+
+// 3. Start the server
+const app = new App({
+  scope: 'App',
+  config: { host: '0.0.0.0', port: 3000, path: { base: '/api' } },
+});
+app.start();
+```
+
+```bash
+# Run it
+bun run src/index.ts
+
+# Visit http://localhost:3000/api/hello
+# API docs at http://localhost:3000/doc/explorer
+```
+
+<div class="tip custom-block" style="padding-top: 8px">
+
+Ready for a step-by-step guide? Follow the [5-minute quickstart →](/guides/get-started/5-minute-quickstart)
+
+</div>
+
+## When to Use Ignis
+
+<div class="use-ignis-grid">
+
+<div class="use-ignis-card">
+<h3>✅ Perfect For</h3>
+<ul>
+<li><strong>SaaS backends</strong> — Multi-tenant, complex business logic</li>
+<li><strong>E-commerce APIs</strong> — Products, orders, payments</li>
+<li><strong>Enterprise apps</strong> — Teams need clear patterns</li>
+<li><strong>Growing projects</strong> — 10+ endpoints that need structure</li>
+<li><strong>REST APIs</strong> — Full CRUD with validation & docs</li>
+<li><strong>Real-time apps</strong> — WebSocket support built-in</li>
+</ul>
+</div>
+
+<div class="use-ignis-card">
+<h3>❌ Consider Alternatives</h3>
+<ul>
+<li><strong>Simple webhooks</strong> — Use plain Hono</li>
+<li><strong>3-5 endpoint APIs</strong> — Ignis adds overhead</li>
+<li><strong>Quick prototypes</strong> — Start with Hono first</li>
+<li><strong>Serverless functions</strong> — Hono alone is lighter</li>
+<li><strong>Static sites</strong> — Use Astro or Next.js</li>
+<li><strong>No TypeScript</strong> — Ignis requires TS</li>
+</ul>
+</div>
+
+</div>
+
+<div style="padding: 3rem 2rem; margin: 2rem 0; border-radius: 16px; background: var(--vp-c-bg-soft); text-align: center;">
+
+<p style="font-size: 0.9rem; color: var(--vp-c-text-2); margin-bottom: 1rem; text-transform: uppercase; letter-spacing: 2px;">Powered by</p>
+
+<div style="display: flex; justify-content: center; flex-wrap: wrap; gap: 2rem; margin-bottom: 1.5rem;">
+<a href="https://hono.dev" target="_blank" style="font-size: 1.2rem; font-weight: 500;">Hono</a>
+<a href="https://orm.drizzle.team" target="_blank" style="font-size: 1.2rem; font-weight: 500;">Drizzle ORM</a>
+<a href="https://zod.dev" target="_blank" style="font-size: 1.2rem; font-weight: 500;">Zod</a>
+<a href="https://www.typescriptlang.org" target="_blank" style="font-size: 1.2rem; font-weight: 500;">TypeScript</a>
+<a href="https://bun.sh" target="_blank" style="font-size: 1.2rem; font-weight: 500;">Bun</a>
+</div>
+
+<hr style="border: none; border-top: 1px solid var(--vp-c-divider); margin: 1.5rem 0;" />
+
+<p style="font-size: 0.9rem; color: var(--vp-c-text-2); margin-bottom: 1rem; text-transform: uppercase; letter-spacing: 2px;">Inspired by</p>
+
+<div style="display: flex; justify-content: center; flex-wrap: wrap; gap: 2rem;">
+<a href="https://spring.io/projects/spring-boot" target="_blank" style="font-size: 1.2rem; font-weight: 500;">Spring Boot</a>
+<a href="https://loopback.io/doc/en/lb4/" target="_blank" style="font-size: 1.2rem; font-weight: 500;">LoopBack 4</a>
+</div>
+
+</div>

package/wiki/references/base/application.md

@@ -1,3 +1,9 @@
+---
+title: Application Reference
+description: Technical reference for AbstractApplication and BaseApplication classes
+difficulty: beginner
+---
+
 # Deep Dive: Application
 
 Technical reference for `AbstractApplication` and `BaseApplication` - the foundation classes for every Ignis application.
@@ -65,3 +71,24 @@ graph TD
 | **`preConfigure()`** | Register all resources (datasources, services, controllers) | Nothing instantiated yet - order doesn't matter |
 | **`register...()`** | Framework iterates bindings and instantiates classes | DataSources initialized first (other layers depend on them) |
 | **`postConfigure()`** | Logic after all resources configured | Example: fetch initial data from repository |
+
+## See Also
+
+- **Related Concepts:**
+  - [Application Guide](/guides/core-concepts/application/) - Creating your first application
+  - [Bootstrapping](/guides/core-concepts/application/bootstrapping) - Auto-discovery of artifacts
+  - [Dependency Injection](/guides/core-concepts/dependency-injection) - How DI works in IGNIS
+  - [Controllers](/guides/core-concepts/controllers) - Registering HTTP endpoints
+
+- **References:**
+  - [Bootstrapping API](/references/base/bootstrapping) - Boot system reference
+  - [Components API](/references/base/components) - Component system
+  - [Environment Variables](/references/configuration/environment-variables) - Configuration management
+  - [Middlewares](/references/base/middlewares) - Request interceptors
+
+- **Tutorials:**
+  - [5-Minute Quickstart](/guides/get-started/5-minute-quickstart) - Create your first app
+  - [Building a CRUD API](/guides/tutorials/building-a-crud-api) - Complete application example
+
+- **Best Practices:**
+  - [Architectural Patterns](/best-practices/architectural-patterns) - Application structure patterns

package/wiki/references/base/bootstrapping.md

@@ -1,3 +1,9 @@
+---
+title: Bootstrapping Reference
+description: Technical reference for application bootstrapping and initialization
+difficulty: advanced
+---
+
 # Bootstrapping API Reference
 
 > **API Reference**: Classes, interfaces, and utilities for application bootstrapping
@@ -9,7 +15,14 @@
 - [Types](#types)
 - [Utilities](#utilities)
 
----
+## Prerequisites
+
+Before reading this document, you should understand:
+
+- [IGNIS Application](./application.md) - Application lifecycle and initialization
+- [Dependency Injection](./dependency-injection.md) - DI container and bindings
+- [Controllers](./controllers.md), [Services](./services.md), and [Repositories](./repositories/) - Core abstractions
+- Convention-based programming patterns
 
 ## Interfaces
 
@@ -44,7 +57,6 @@ export class Application extends BaseApplication implements IBootableApplication
 }
 ```
 
----
 
 ### IBootOptions
 
@@ -88,7 +100,6 @@ const bootOptions: IBootOptions = {
 };
 ```
 
----
 
 ### IArtifactOptions
 
@@ -125,7 +136,6 @@ const customOptions: IArtifactOptions = {
 };
 ```
 
----
 
 ### IBooter
 
@@ -163,7 +173,6 @@ export class CustomBooter implements IBooter {
 }
 ```
 
----
 
 ### IBooterOptions
 
@@ -196,7 +205,6 @@ const options: IBooterOptions = {
 };
 ```
 
----
 
 ### IBootExecutionOptions
 
@@ -234,7 +242,6 @@ await bootstrapper.boot({
 });
 ```
 
----
 
 ### IBootstrapper
 
@@ -250,7 +257,6 @@ interface IBootstrapper {
 |--------|--------|-------------|
 | `boot(opts)` | `Promise<IBootReport>` | Execute boot process with options |
 
----
 
 ### IBootReport
 
@@ -262,7 +268,6 @@ interface IBootReport {}
 
 Currently an empty interface, reserved for future enhancements (timing, errors, artifact counts, etc.).
 
----
 
 ### IApplication
 
@@ -278,7 +283,6 @@ interface IApplication extends Container {
 |--------|--------|-------------|
 | `getProjectRoot()` | `string` | Get absolute path to project root |
 
----
 
 ## Classes
 
@@ -359,7 +363,6 @@ Generates boot completion report.
 private generateReport(): IBootReport
 ```
 
----
 
 ### BaseArtifactBooter
 
@@ -476,7 +479,6 @@ protected getPattern(): string
 | `discoveredFiles` | `string[]` | Array of discovered file paths |
 | `loadedClasses` | `TClass<any>[]` | Array of loaded class constructors |
 
----
 
 ### ControllerBooter
 
@@ -504,7 +506,6 @@ constructor(
 | Extensions | `['.controller.js']` |
 | Binding Key | `controllers.{ClassName}` |
 
----
 
 ### ServiceBooter
 
@@ -532,7 +533,6 @@ constructor(
 | Extensions | `['.service.js']` |
 | Binding Key | `services.{ClassName}` |
 
----
 
 ### RepositoryBooter
 
@@ -560,7 +560,6 @@ constructor(
 | Extensions | `['.repository.js']` |
 | Binding Key | `repositories.{ClassName}` |
 
----
 
 ### DatasourceBooter
 
@@ -588,7 +587,6 @@ constructor(
 | Extensions | `['.datasource.js']` |
 | Binding Key | `datasources.{ClassName}` |
 
----
 
 ## Types
 
@@ -629,7 +627,6 @@ Abstract constructor type.
 type TAbstractConstructor<T> = abstract new (...args: any[]) => T
 ```
 
----
 
 ## Utilities
 
@@ -661,7 +658,6 @@ const files = await discoverFiles({
 // ['/path/to/project/controllers/user.controller.js', ...]
 ```
 
----
 
 ### loadClasses()
 
@@ -694,7 +690,6 @@ const classes = await loadClasses({
 // [UserController, ProductController]
 ```
 
----
 
 ### isClass()
 
@@ -723,7 +718,6 @@ for (const exported of Object.values(module)) {
 }
 ```
 
----
 
 ## Constants
 
@@ -743,7 +737,6 @@ import { BOOT_PHASES } from '@venizia/ignis-boot';
 await bootstrapper.boot({ phases: BOOT_PHASES });
 ```
 
----
 
 ## Mixin Functions
 
@@ -779,11 +772,22 @@ const app = new MyApp();
 await app.boot();
 ```
 
+
 ---
 
-## Related Documentation
+## See Also
+
+- **Related References:**
+  - [Application](./application.md) - Application lifecycle and initialization
+  - [Dependency Injection](./dependency-injection.md) - DI container and bindings
+  - [Components](./components.md) - Pluggable modules and components
+  - [Boot Package](/references/src-details/boot.md) - Boot package implementation details
+
+- **Guides:**
+  - [Bootstrapping Concepts](/guides/core-concepts/application/bootstrapping)
+  - [Application Guide](/guides/core-concepts/application/)
+  - [Auto-Discovery](/guides/core-concepts/auto-discovery.md)
 
-- [Bootstrapping Concepts](/get-started/core-concepts/bootstrapping.md)
-- [Boot Package Reference](/references/src-details/boot.md)
-- [Application Guide](/get-started/core-concepts/application.md)
-- [Dependency Injection](/references/base/dependency-injection.md)
+- **Best Practices:**
+  - [Application Structure](/best-practices/architecture/project-structure.md)
+  - [Environment Configuration](/best-practices/configuration/environment.md)