§NodeKit

NodeKit est une boîte à outils simple pour vos applications, scripts et bibliothèques Node.js. Il fournit des fonctionnalités pour la journalisation, la télémétrie, la configuration et la gestion des erreurs, afin que vous puissiez avoir une base familière dans vos différents projets.

§Démarrage rapide

Ajoutez la dépendance à votre projet :

npm install --save @gravity-ui/nodekit

Importez et initialisez ensuite NodeKit dans votre application :

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

const nodeKit = new NodeKit();
nodekit.ctx.log('App is ready');

§Documentation

Consultez le répertoire docs/ pour une documentation supplémentaire :

• docs/configuration.md explique comment configurer NodeKit lui-même et vos applications basées sur NodeKit.
• docs/contexts.md décrit le concept des contextes NodeKit, de la journalisation et du traçage.
• docs/app-error.md contient la description d'une classe d'erreur personnalisée utile que NodeKit fournit pour vos applications.
• docs/utils.md liste quelques fonctions d'aide supplémentaires incluses avec NodeKit.

§Contribution

§Démarrage rapide

Récupérez des copies du dépôt NodeKit et des applications d'exemple :

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

Liez votre NodeKit à npm et lancez le compilateur :

cd nodekit && npm link && npm run dev

Ensuite, dans un autre terminal, allez dans les exemples, ouvrez celui qui vous intéresse, liez-y votre NodeKit, puis démarrez l'application :

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

À ce stade, vous pouvez apporter des modifications à la fois à NodeKit et à l'application de démonstration, et voir les résultats en temps réel.