<div class="language-selector">
  <a href="/README.md">English</a>
  <a href="/README.de.md">Deutsch</a>
</div>

§NodeKit

NodeKit ist ein einfaches Toolkit für Ihre Node.js-Anwendungen, Skripte und Bibliotheken. Es bietet Funktionalität für Logging, Telemetrie, Konfiguration und Fehlerbehandlung, sodass Sie eine vertraute Grundlage in Ihren verschiedenen Projekten haben.

§Erste Schritte

Fügen Sie die Abhängigkeit zu Ihrem Projekt hinzu:

npm install --save @gravity-ui/nodekit

Importieren und initialisieren Sie dann NodeKit in Ihrer Anwendung:

import {NodeKit} from '@gravity-ui/nodekit';

const nodeKit = new NodeKit();
nodekit.ctx.log('App ist bereit');

§Dokumentation

Im Verzeichnis docs/ finden Sie zusätzliche Dokumentation:

• docs/configuration.md beschreibt, wie Sie sowohl NodeKit selbst als auch Ihre NodeKit-basierten Anwendungen konfigurieren können.
• docs/contexts.md erläutert das Konzept von NodeKit-Kontexten, Logging und Tracing.
• docs/app-error.md enthält eine Beschreibung der nützlichen benutzerdefinierten Fehlerklasse, die NodeKit für Ihre Anwendungen bereitstellt.
• docs/utils.md listet einige zusätzliche Hilfsfunktionen auf, die mit NodeKit gebündelt sind.

§Mitwirken

§Erste Schritte

Holen Sie sich Kopien des NodeKit-Repositorys und der Beispielanwendungen:

git clone git@github.com:gravity-ui/nodekit
git clone git@github.com:gravity-ui/nodekit-examples

Verknüpfen Sie Ihr NodeKit mit npm und starten Sie den Compiler:

cd nodekit && npm link && npm run dev

Öffnen Sie dann in einem anderen Terminal die Beispiele, wählen Sie das aus, das Sie interessiert, verknüpfen Sie Ihr NodeKit dort und starten Sie die Anwendung:

cd nodekit-examples/basic-app && npm i && npm link @gravity-ui/nodekit
npm run dev

An diesem Punkt können Sie Änderungen sowohl an NodeKit als auch an der Demo-App vornehmen und die Ergebnisse in Echtzeit sehen.