# @archsense/orakul-starter

> Visualize your architecture that make sense

Latest version **0.3.1** (published 2023-09-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @archsense/orakul-starter
pnpm add @archsense/orakul-starter
yarn add @archsense/orakul-starter
bun add @archsense/orakul-starter
```

Provides the command `orakul`.

## Health

**Score 35/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.3.1 |
| Published | 2023-09-07 |
| First published | 2023-02-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 11 |
| Unpacked size | 129.6 KB |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 31 |
| Author | Sergey Bolshchikov |
| Maintainers | bolshchikov |
| Keywords | architecture, visualization |

## Links

- npm: https://www.npmjs.com/package/@archsense/orakul-starter
- Repository: https://github.com/ArchSense/archsense-mono
- Issues: https://github.com/ArchSense/archsense-mono/issues
- npm.io page: https://npm.io/package/@archsense/orakul-starter

## Dependencies (11)

- [open](https://npm.io/package/open.md) ^8.4.2
- [rxjs](https://npm.io/package/rxjs.md) ^7.2.0
- [rimraf](https://npm.io/package/rimraf.md) ^3.0.2
- [@nestjs/core](https://npm.io/package/@nestjs/core.md) ^9.0.0
- [@nestjs/common](https://npm.io/package/@nestjs/common.md) ^9.0.0
- [@nestjs/config](https://npm.io/package/@nestjs/config.md) ^2.3.1
- [@archsense/scout](https://npm.io/package/@archsense/scout.md) ^0.2.5
- [reflect-metadata](https://npm.io/package/reflect-metadata.md) ^0.1.13
- [@archsense/orakul-ui](https://npm.io/package/@archsense/orakul-ui.md) ^0.3.1
- [@nestjs/serve-static](https://npm.io/package/@nestjs/serve-static.md) ^3.0.1
- [@nestjs/platform-express](https://npm.io/package/@nestjs/platform-express.md) ^9.3.9

## Alternatives

- [d3-force-3d](https://npm.io/package/d3-force-3d.md) — 1.0M weekly downloads
- [ng2-charts](https://npm.io/package/ng2-charts.md) — 486.8K weekly downloads
- [@arcgis/core](https://npm.io/package/@arcgis/core.md) — 257.8K weekly downloads
- [react-sparklines](https://npm.io/package/react-sparklines.md) — 249.3K weekly downloads
- [react-native-gifted-charts](https://npm.io/package/react-native-gifted-charts.md) — 182.3K weekly downloads

## Recent versions

- 0.3.1 (latest) — 2023-09-07
- 0.1.0-rc.0 (next) — 2023-02-27
- 0.2.2 — 2023-09-06
- 0.2.1 — 2023-04-23
- 0.2.0 — 2023-04-19
- 0.1.6 — 2023-04-09
- 0.1.5 — 2023-03-29
- 0.1.4 — 2023-03-20
- 0.1.3 — 2023-03-20
- 0.1.2 — 2023-03-19
- 0.1.1 — 2023-03-01
- 0.1.0 — 2023-03-01
- 0.1.0-rc.1 — 2023-03-01

## README

# Orakul

> Project architecture visualization tool

## How to use

### Configure npm script for a project

1. Install the dependency `npm install --save-dev @archsense/orakul-starter`

2. Configure npm script
```json
{
  ...
  "scripts": {
    ...
    "orakul": "npx orakul nestjs -p <path-to-root-folder>",
    ...
  }, 
}
```

### Configuration file for monorepo

1. At the root of your project create the configuration file `scout.json` with the following properties:
```json
{  
  "id": "<project/domain-id>",
  "src": "<path-to-src-folder | microservices>",
  "include": [
    "<list-of-folders-in-src-to-include-optional>"
  ],
  "exclude": [
    "<list-of-folders-in-src-to-exclude-optional>"
  ]
}
```

2. Configure npm script
```json
{
  ...
  "scripts": {
    ...
    "orakul": "npx orakul nestjs -c <path-to-config-folder>",
    ...
  }, 
}
```

3. Go to [http://localhost:4501](http://localhost:4501) to see the visualization

## Why Orakul

1. Just CLI command - no additional code required
1. Support of NestJs microservices
1. Different levels of visualizations: modules level and low level
1. See only what you are interested in

---
_Source: https://npm.io/package/@archsense/orakul-starter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._