https://github.com/tipogi/bushido.library

CLI NestJS application to merge/add nodes in bushido.guide. Add in the bookmarks folder the URL with details and run the command
https://github.com/tipogi/bushido.library

cli json neo4j nestjs typescript

Last synced: 11 days ago
JSON representation

CLI NestJS application to merge/add nodes in bushido.guide. Add in the bookmarks folder the URL with details and run the command

• Host: GitHub
• URL: https://github.com/tipogi/bushido.library
• Owner: tipogi
• License: gpl-3.0
• Created: 2022-04-11T09:34:34.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-10-06T10:06:05.000Z (12 months ago)
• Last Synced: 2023-10-06T11:26:15.358Z (12 months ago)
• Topics: cli, json, neo4j, nestjs, typescript
• Language: TypeScript
• Homepage:
• Size: 668 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Motivation

This repository is a CLI application to feed domains into a graph database as [Neo4J](https://neo4j.com/). Once the import finish, we have an endpoint to consume that information. That data, we could consume differently but one of the uses-case would be to render that in a web page

## Overview

![Library Architecture](./docs/assets/arch.png)

The user interacts with CLI sending different commands to populate, update or health-check the domain library (graph db). There are two main parts in the application which are structured in different folders:

- __bookmarks__: All the domains that we want to add in our library and it follows, the tree data structure.

- __cli__: console server to interact with the database to save/delete domains. More info in [cli](./cli/README.md)

## Commands

> __Note!__ If we change the code and we want that change will be reflected in the commands, we need to create a reproducible build: `npm run build`

If you want to have an extended info about commnad go to [cli](./cli/README.md)

```bash

# Enter in the application file

cd cli

# Create the files to import, topic.json and domain.json

npm run bushido-cli generate

# First, import the topics in the graph DB

npm run bushido-cli import topic

# and then, the domains

npm run bushido-cli import domain

# EXTRA

npm run bushido-cli optimise-graph

npm run bushido-cli domain-url-check

```

## Logs

Whenever we run a command, we create a log to follow the editing process in the domain graph. That `logs` we can find in __/cli/logs__