https://github.com/gravity-ui/nodekit
Simple toolkit for Node.js applications and scripts
https://github.com/gravity-ui/nodekit
Last synced: 3 months ago
JSON representation
Simple toolkit for Node.js applications and scripts
- Host: GitHub
- URL: https://github.com/gravity-ui/nodekit
- Owner: gravity-ui
- License: mit
- Created: 2023-01-07T15:53:53.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2026-03-01T13:30:25.000Z (4 months ago)
- Last Synced: 2026-03-01T16:52:40.726Z (4 months ago)
- Language: TypeScript
- Homepage: https://github.com/orgs/gravity-ui/projects/2
- Size: 738 KB
- Stars: 13
- Watchers: 0
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README-ru.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# NodeKit
`NodeKit` — это простой набор инструментов для приложений, скриптов и библиотек Node.js, который включает поддержку логирования, телеметрии, конфигурации и обработки ошибок, обеспечивая стабильную основу для работы с различными проектами.
## Начало работы
Добавьте зависимость к проекту:
```bash
npm install --save @gravity-ui/nodekit
```
Импортируйте и инициализируйте `NodeKit` в приложении:
```typescript
import {NodeKit} from '@gravity-ui/nodekit';
const nodeKit = new NodeKit();
nodekit.ctx.log('App is ready');
```
## Документация
Дополнительная документация находится в папке `docs/`:
- [`docs/configuration.md`](https://github.com/gravity-ui/nodekit/blob/main/docs/configuration.md) — описывает, как настроить сам `NodeKit` и приложения, основанные на `NodeKit`.
- [`docs/contexts.md`](https://github.com/gravity-ui/nodekit/blob/main/docs/contexts.md) — описывает концепцию контекстов `NodeKit`, а также логирование и трассировку.
- [`docs/app-error.md`](https://github.com/gravity-ui/nodekit/blob/main/docs/app-error.md) — содержит описание полезного пользовательского класса ошибок, который предлагает `NodeKit` для ваших приложений.
- [`docs/utils.md`](https://github.com/gravity-ui/nodekit/blob/main/docs/utils.md) — включает список дополнительных вспомогательных функций, входящих в состав `NodeKit`.
## Вклад в проект
### Начало работы
Склонируйте репозиторий `NodeKit` и примеры приложений:
```bash
git clone git@github.com:gravity-ui/nodekit
git clone git@github.com:gravity-ui/nodekit-examples
```
Свяжите `NodeKit` с `npm` и запустите компилятор:
```bash
cd nodekit && npm link && npm run dev
```
В другом терминале перейдите в папку с примерами и откройте интересующий пример. Свяжите его с вашим `NodeKit` и запустите приложение:
```bash
cd nodekit-examples/basic-app && npm i && npm link @gravity-ui/nodekit
npm run dev
```
После выполнения этих шагов можно вносить изменения как в `NodeKit`, так и в демонстрационное приложение, при этом результаты таких изменений будут отражаться в режиме реального времени.