@venizia/ignis-docs 0.0.1-1
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.
- package/mcp-server/dist/common/config.d.ts +27 -0
- package/mcp-server/dist/common/config.d.ts.map +1 -0
- package/mcp-server/dist/common/config.js +27 -0
- package/mcp-server/dist/common/config.js.map +1 -0
- package/mcp-server/dist/common/index.d.ts +3 -0
- package/mcp-server/dist/common/index.d.ts.map +1 -0
- package/mcp-server/dist/common/index.js +19 -0
- package/mcp-server/dist/common/index.js.map +1 -0
- package/mcp-server/dist/common/paths.d.ts +13 -0
- package/mcp-server/dist/common/paths.d.ts.map +1 -0
- package/mcp-server/dist/common/paths.js +23 -0
- package/mcp-server/dist/common/paths.js.map +1 -0
- package/mcp-server/dist/helpers/docs.helper.d.ts +81 -0
- package/mcp-server/dist/helpers/docs.helper.d.ts.map +1 -0
- package/mcp-server/dist/helpers/docs.helper.js +171 -0
- package/mcp-server/dist/helpers/docs.helper.js.map +1 -0
- package/mcp-server/dist/helpers/index.d.ts +3 -0
- package/mcp-server/dist/helpers/index.d.ts.map +1 -0
- package/mcp-server/dist/helpers/index.js +19 -0
- package/mcp-server/dist/helpers/index.js.map +1 -0
- package/mcp-server/dist/helpers/logger.helper.d.ts +7 -0
- package/mcp-server/dist/helpers/logger.helper.d.ts.map +1 -0
- package/mcp-server/dist/helpers/logger.helper.js +22 -0
- package/mcp-server/dist/helpers/logger.helper.js.map +1 -0
- package/mcp-server/dist/index.d.ts +3 -0
- package/mcp-server/dist/index.d.ts.map +1 -0
- package/mcp-server/dist/index.js +62 -0
- package/mcp-server/dist/index.js.map +1 -0
- package/mcp-server/dist/tools/base.tool.d.ts +98 -0
- package/mcp-server/dist/tools/base.tool.d.ts.map +1 -0
- package/mcp-server/dist/tools/base.tool.js +47 -0
- package/mcp-server/dist/tools/base.tool.js.map +1 -0
- package/mcp-server/dist/tools/get-doc-content.tool.d.ts +30 -0
- package/mcp-server/dist/tools/get-doc-content.tool.d.ts.map +1 -0
- package/mcp-server/dist/tools/get-doc-content.tool.js +127 -0
- package/mcp-server/dist/tools/get-doc-content.tool.js.map +1 -0
- package/mcp-server/dist/tools/get-doc-metadata.tool.d.ts +40 -0
- package/mcp-server/dist/tools/get-doc-metadata.tool.d.ts.map +1 -0
- package/mcp-server/dist/tools/get-doc-metadata.tool.js +121 -0
- package/mcp-server/dist/tools/get-doc-metadata.tool.js.map +1 -0
- package/mcp-server/dist/tools/index.d.ts +8 -0
- package/mcp-server/dist/tools/index.d.ts.map +1 -0
- package/mcp-server/dist/tools/index.js +18 -0
- package/mcp-server/dist/tools/index.js.map +1 -0
- package/mcp-server/dist/tools/list-categories.tool.d.ts +20 -0
- package/mcp-server/dist/tools/list-categories.tool.d.ts.map +1 -0
- package/mcp-server/dist/tools/list-categories.tool.js +105 -0
- package/mcp-server/dist/tools/list-categories.tool.js.map +1 -0
- package/mcp-server/dist/tools/list-docs.tool.d.ts +32 -0
- package/mcp-server/dist/tools/list-docs.tool.d.ts.map +1 -0
- package/mcp-server/dist/tools/list-docs.tool.js +121 -0
- package/mcp-server/dist/tools/list-docs.tool.js.map +1 -0
- package/mcp-server/dist/tools/search-docs.tool.d.ts +32 -0
- package/mcp-server/dist/tools/search-docs.tool.d.ts.map +1 -0
- package/mcp-server/dist/tools/search-docs.tool.js +120 -0
- package/mcp-server/dist/tools/search-docs.tool.js.map +1 -0
- package/package.json +102 -0
- package/wiki/get-started/5-minute-quickstart.md +266 -0
- package/wiki/get-started/best-practices/api-usage-examples.md +222 -0
- package/wiki/get-started/best-practices/architectural-patterns.md +129 -0
- package/wiki/get-started/best-practices/code-style-standards.md +122 -0
- package/wiki/get-started/best-practices/common-pitfalls.md +136 -0
- package/wiki/get-started/best-practices/contribution-workflow.md +145 -0
- package/wiki/get-started/best-practices/deployment-strategies.md +121 -0
- package/wiki/get-started/best-practices/performance-optimization.md +88 -0
- package/wiki/get-started/best-practices/security-guidelines.md +97 -0
- package/wiki/get-started/best-practices/troubleshooting-tips.md +100 -0
- package/wiki/get-started/building-a-crud-api.md +717 -0
- package/wiki/get-started/core-concepts/application.md +168 -0
- package/wiki/get-started/core-concepts/components.md +96 -0
- package/wiki/get-started/core-concepts/controllers.md +441 -0
- package/wiki/get-started/core-concepts/dependency-injection.md +160 -0
- package/wiki/get-started/core-concepts/persistent.md +591 -0
- package/wiki/get-started/core-concepts/services.md +88 -0
- package/wiki/get-started/index.md +65 -0
- package/wiki/get-started/mcp-docs-server.md +840 -0
- package/wiki/get-started/philosophy.md +123 -0
- package/wiki/get-started/prerequisites.md +113 -0
- package/wiki/get-started/quickstart.md +382 -0
- package/wiki/index.md +48 -0
- package/wiki/references/base/application.md +67 -0
- package/wiki/references/base/components.md +80 -0
- package/wiki/references/base/controllers.md +361 -0
- package/wiki/references/base/datasources.md +105 -0
- package/wiki/references/base/dependency-injection.md +83 -0
- package/wiki/references/base/models.md +104 -0
- package/wiki/references/base/repositories.md +118 -0
- package/wiki/references/base/services.md +97 -0
- package/wiki/references/components/authentication.md +224 -0
- package/wiki/references/components/health-check.md +190 -0
- package/wiki/references/components/index.md +61 -0
- package/wiki/references/components/request-tracker.md +35 -0
- package/wiki/references/components/socket-io.md +127 -0
- package/wiki/references/components/swagger.md +175 -0
- package/wiki/references/helpers/cron.md +94 -0
- package/wiki/references/helpers/crypto.md +117 -0
- package/wiki/references/helpers/env.md +67 -0
- package/wiki/references/helpers/error.md +80 -0
- package/wiki/references/helpers/index.md +21 -0
- package/wiki/references/helpers/inversion.md +141 -0
- package/wiki/references/helpers/logger.md +98 -0
- package/wiki/references/helpers/network.md +143 -0
- package/wiki/references/helpers/queue.md +131 -0
- package/wiki/references/helpers/redis.md +121 -0
- package/wiki/references/helpers/socket-io.md +103 -0
- package/wiki/references/helpers/storage.md +130 -0
- package/wiki/references/helpers/testing.md +115 -0
- package/wiki/references/helpers/worker-thread.md +162 -0
- package/wiki/references/src-details/core.md +249 -0
- package/wiki/references/src-details/dev-configs.md +302 -0
- package/wiki/references/src-details/docs.md +61 -0
- package/wiki/references/src-details/helpers.md +211 -0
- package/wiki/references/src-details/inversion.md +345 -0
- package/wiki/references/src-details/mcp-server.md +726 -0
- package/wiki/references/utilities/crypto.md +39 -0
- package/wiki/references/utilities/date.md +72 -0
- package/wiki/references/utilities/index.md +12 -0
- package/wiki/references/utilities/module.md +40 -0
- package/wiki/references/utilities/parse.md +68 -0
- package/wiki/references/utilities/performance.md +64 -0
- package/wiki/references/utilities/promise.md +83 -0
- package/wiki/references/utilities/request.md +66 -0
- package/wiki/references/utilities/schema.md +88 -0
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# Getting Started with Ignis
|
|
2
|
+
|
|
3
|
+
Welcome to Ignis! This guide takes you from zero to a fully functional, database-connected REST API.
|
|
4
|
+
|
|
5
|
+
**Recommended learning path:**
|
|
6
|
+
|
|
7
|
+
## 1. Prerequisites
|
|
8
|
+
|
|
9
|
+
Before starting, ensure you have the required tools installed.
|
|
10
|
+
|
|
11
|
+
[Check Prerequisites](./prerequisites.md)
|
|
12
|
+
|
|
13
|
+
## 2. Philosophy
|
|
14
|
+
|
|
15
|
+
Understand the "why" behind Ignis - how it combines enterprise-grade patterns with high performance.
|
|
16
|
+
|
|
17
|
+
[Learn the Philosophy](./philosophy.md)
|
|
18
|
+
|
|
19
|
+
## 3. Choose Your Starting Point
|
|
20
|
+
|
|
21
|
+
### Option A: 5-Minute Quickstart (Recommended for First-Timers)
|
|
22
|
+
|
|
23
|
+
Build your first "Hello World" endpoint in 5 minutes. No database, minimal setup.
|
|
24
|
+
|
|
25
|
+
[5-Minute Quickstart](./5-minute-quickstart.md) ⚡
|
|
26
|
+
|
|
27
|
+
### Option B: Complete Setup Guide
|
|
28
|
+
|
|
29
|
+
Full production setup with ESLint, Prettier, and proper project structure.
|
|
30
|
+
|
|
31
|
+
[Complete Setup Guide](./quickstart.md)
|
|
32
|
+
|
|
33
|
+
## 4. Building a CRUD API
|
|
34
|
+
|
|
35
|
+
**Most important guide** - build a complete Todo API covering:
|
|
36
|
+
- Models with Drizzle ORM
|
|
37
|
+
- DataSources & Repositories
|
|
38
|
+
- Controllers with auto-generated endpoints
|
|
39
|
+
- Dependency Injection
|
|
40
|
+
|
|
41
|
+
[Build a CRUD API](./building-a-crud-api.md)
|
|
42
|
+
|
|
43
|
+
## 5. Core Concepts
|
|
44
|
+
|
|
45
|
+
Deep dive into framework internals:
|
|
46
|
+
|
|
47
|
+
- [The Application Class](./core-concepts/application.md) - Lifecycle and configuration
|
|
48
|
+
- [Dependency Injection](./core-concepts/dependency-injection.md) - DI container patterns
|
|
49
|
+
- [Controllers](./core-concepts/controllers.md) - Routing and request handling
|
|
50
|
+
- [Services](./core-concepts/services.md) - Business logic layer
|
|
51
|
+
- [Persistent Layer](./core-concepts/persistent.md) - Models, DataSources, Repositories
|
|
52
|
+
- [Components](./core-concepts/components.md) - Reusable modules
|
|
53
|
+
|
|
54
|
+
## 6. Best Practices
|
|
55
|
+
|
|
56
|
+
Production-ready patterns and practices:
|
|
57
|
+
|
|
58
|
+
- [Architectural Patterns](./best-practices/architectural-patterns.md) - Layered architecture
|
|
59
|
+
- [API Usage Examples](./best-practices/api-usage-examples.md) - Real-world patterns
|
|
60
|
+
- [Code Style Standards](./best-practices/code-style-standards.md) - ESLint & Prettier
|
|
61
|
+
- [Security Guidelines](./best-practices/security-guidelines.md) - Protect your API
|
|
62
|
+
- [Performance Optimization](./best-practices/performance-optimization.md) - Speed improvements
|
|
63
|
+
- [Deployment Strategies](./best-practices/deployment-strategies.md) - Go to production
|
|
64
|
+
- [Troubleshooting Tips](./best-practices/troubleshooting-tips.md) - Common issues
|
|
65
|
+
- [Contribution Workflow](./best-practices/contribution-workflow.md) - Contribute to Ignis
|