nestlens 0.1.0 → 0.1.2

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 (2) hide show
  1. package/README.md +44 -75
  2. package/package.json +4 -2
package/README.md CHANGED
@@ -22,40 +22,15 @@
22
22
  </p>
23
23
 
24
24
  <p align="center">
25
- <a href="https://nestlens-docs.vercel.app"><strong>Documentation</strong></a> ·
26
- <a href="https://nestlens-docs.vercel.app/docs/getting-started/installation"><strong>Getting Started</strong></a> ·
27
- <a href="https://github.com/mogretici/nestlens/issues"><strong>Report Bug</strong></a>
25
+ <a href="https://nestlens-docs.vercel.app/docs/getting-started/installation"><img src="https://img.shields.io/badge/Getting_Started-0ea5e9?style=for-the-badge" alt="Getting Started" /></a>
26
+ <a href="https://nestlens-docs.vercel.app/docs/configuration/basic-config"><img src="https://img.shields.io/badge/Configuration-8b5cf6?style=for-the-badge" alt="Configuration" /></a>
27
+ <a href="https://nestlens-docs.vercel.app/docs/watchers/overview"><img src="https://img.shields.io/badge/Watchers-10b981?style=for-the-badge" alt="Watchers" /></a>
28
+ <a href="https://nestlens-docs.vercel.app/docs/security/access-control"><img src="https://img.shields.io/badge/Security-f59e0b?style=for-the-badge" alt="Security" /></a>
28
29
  </p>
29
30
 
30
- <br/>
31
-
32
- ## Install
33
-
34
- ```bash
35
- npm install nestlens
36
- ```
37
-
38
- ## Quick Start
39
-
40
- ```typescript
41
- import { NestLensModule } from 'nestlens';
42
-
43
- @Module({
44
- imports: [
45
- NestLensModule.forRoot({
46
- enabled: process.env.NODE_ENV !== 'production',
47
- }),
48
- ],
49
- })
50
- export class AppModule {}
51
- ```
52
-
53
- Visit **http://localhost:3000/nestlens** and start debugging.
54
-
55
- <br/>
56
-
57
31
  ## Why NestLens?
58
32
 
33
+ <div align="center">
59
34
  <table>
60
35
  <tr>
61
36
  <td width="33%" valign="top">
@@ -81,65 +56,59 @@ IP whitelist, role-based access, and automatic data masking for production safet
81
56
  </td>
82
57
  </tr>
83
58
  </table>
59
+ </div>
84
60
 
85
- <br/>
86
-
87
- ## 18 Watchers
88
-
89
- Track everything your NestJS application does:
90
-
91
- | Category | Watchers |
92
- |----------|----------|
93
- | **HTTP & Errors** | Request · Exception · Log |
94
- | **Database** | Query · Cache · Redis · Model |
95
- | **Background** | Job · Schedule · Event · Batch |
96
- | **Communication** | Mail · HTTP Client · Notification |
97
- | **System** | Gate · Command · View · Dump |
98
-
99
- <p align="right">
100
- <a href="https://nestlens-docs.vercel.app/docs/watchers/overview">See all watchers →</a>
101
- </p>
102
61
 
103
62
  <br/>
104
63
 
105
- ## Integrations
106
-
107
- Works out of the box with your existing stack:
64
+ ## Install
108
65
 
109
- - **TypeORM** - Query & Model tracking
110
- - **Prisma** - Query & Model tracking
111
- - **Bull / BullMQ** - Job monitoring
112
- - **Redis** - Command tracking
66
+ ```bash
67
+ npm install nestlens
68
+ ```
113
69
 
114
- <p align="right">
115
- <a href="https://nestlens-docs.vercel.app/docs/integrations/typeorm">View integrations →</a>
116
- </p>
70
+ ## Quick Start
117
71
 
118
- <br/>
72
+ ```typescript
73
+ import { NestLensModule } from 'nestlens';
119
74
 
120
- ## Documentation
75
+ @Module({
76
+ imports: [
77
+ NestLensModule.forRoot({
78
+ enabled: process.env.NODE_ENV !== 'production',
79
+ }),
80
+ ],
81
+ })
82
+ export class AppModule {}
83
+ ```
121
84
 
122
- | | |
123
- |---|---|
124
- | [**Getting Started**](https://nestlens-docs.vercel.app/docs/getting-started/installation) | Installation and quick start guide |
125
- | [**Configuration**](https://nestlens-docs.vercel.app/docs/configuration/basic-config) | All configuration options |
126
- | [**Watchers**](https://nestlens-docs.vercel.app/docs/watchers/overview) | 18 watchers documentation |
127
- | [**Security**](https://nestlens-docs.vercel.app/docs/security/access-control) | Access control and data masking |
85
+ Visit **http://localhost:3000/nestlens** and start debugging.
128
86
 
129
87
  <br/>
130
88
 
131
- ## Contributing
132
-
133
- Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
134
-
89
+ <p align="center">
90
+ <a href="https://nestlens-docs.vercel.app/docs/watchers/request"><img src="https://img.shields.io/badge/Request-0ea5e9?style=flat-square" alt="Request" /></a>
91
+ <a href="https://nestlens-docs.vercel.app/docs/watchers/exception"><img src="https://img.shields.io/badge/Exception-ef4444?style=flat-square" alt="Exception" /></a>
92
+ <a href="https://nestlens-docs.vercel.app/docs/watchers/log"><img src="https://img.shields.io/badge/Log-8b5cf6?style=flat-square" alt="Log" /></a>
93
+ <a href="https://nestlens-docs.vercel.app/docs/watchers/query"><img src="https://img.shields.io/badge/Query-10b981?style=flat-square" alt="Query" /></a>
94
+ <a href="https://nestlens-docs.vercel.app/docs/watchers/model"><img src="https://img.shields.io/badge/Model-10b981?style=flat-square" alt="Model" /></a>
95
+ <a href="https://nestlens-docs.vercel.app/docs/watchers/cache"><img src="https://img.shields.io/badge/Cache-10b981?style=flat-square" alt="Cache" /></a>
96
+ <a href="https://nestlens-docs.vercel.app/docs/watchers/redis"><img src="https://img.shields.io/badge/Redis-dc382d?style=flat-square" alt="Redis" /></a>
97
+ <a href="https://nestlens-docs.vercel.app/docs/watchers/job"><img src="https://img.shields.io/badge/Job-f59e0b?style=flat-square" alt="Job" /></a>
98
+ <a href="https://nestlens-docs.vercel.app/docs/watchers/schedule"><img src="https://img.shields.io/badge/Schedule-f59e0b?style=flat-square" alt="Schedule" /></a>
135
99
  <br/>
100
+ <a href="https://nestlens-docs.vercel.app/docs/watchers/event"><img src="https://img.shields.io/badge/Event-f59e0b?style=flat-square" alt="Event" /></a>
101
+ <a href="https://nestlens-docs.vercel.app/docs/watchers/batch"><img src="https://img.shields.io/badge/Batch-f59e0b?style=flat-square" alt="Batch" /></a>
102
+ <a href="https://nestlens-docs.vercel.app/docs/watchers/mail"><img src="https://img.shields.io/badge/Mail-ec4899?style=flat-square" alt="Mail" /></a>
103
+ <a href="https://nestlens-docs.vercel.app/docs/watchers/http-client"><img src="https://img.shields.io/badge/HTTP_Client-ec4899?style=flat-square" alt="HTTP Client" /></a>
104
+ <a href="https://nestlens-docs.vercel.app/docs/watchers/notification"><img src="https://img.shields.io/badge/Notification-ec4899?style=flat-square" alt="Notification" /></a>
105
+ <a href="https://nestlens-docs.vercel.app/docs/watchers/gate"><img src="https://img.shields.io/badge/Gate-64748b?style=flat-square" alt="Gate" /></a>
106
+ <a href="https://nestlens-docs.vercel.app/docs/watchers/command"><img src="https://img.shields.io/badge/Command-64748b?style=flat-square" alt="Command" /></a>
107
+ <a href="https://nestlens-docs.vercel.app/docs/watchers/view"><img src="https://img.shields.io/badge/View-64748b?style=flat-square" alt="View" /></a>
108
+ <a href="https://nestlens-docs.vercel.app/docs/watchers/dump"><img src="https://img.shields.io/badge/Dump-64748b?style=flat-square" alt="Dump" /></a>
109
+ </p>
136
110
 
137
- ## License
138
-
139
- MIT © [Lütfü Öğretici](https://github.com/mogretici)
140
-
141
- <br/>
142
111
 
143
112
  <p align="center">
144
- <sub>Built with ❤️ for the NestJS community</sub>
113
+ <sub>Made by <a href="https://github.com/mogretici">Lütfü Öğretici</a> for the NestJS community ❤️ </sub>
145
114
  </p>
package/package.json CHANGED
@@ -1,11 +1,13 @@
1
1
  {
2
2
  "name": "nestlens",
3
- "version": "0.1.0",
3
+ "version": "0.1.2",
4
4
  "description": "Laravel Telescope-like debugging and monitoring tool for NestJS",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
7
7
  "files": [
8
- "dist"
8
+ "dist",
9
+ "README.md",
10
+ "LICENSE"
9
11
  ],
10
12
  "scripts": {
11
13
  "build": "rimraf dist && tsc && npm run build:dashboard",