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

Motivation

This repository is a CLI application to feed domains into a graph database as Neo4J. 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

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

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

# 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