@robb_j/golden-retriever-cli

The cli for fetching and normalising entities from a APIs

Usage no npm install needed!

<script type="module">
  import robbJGoldenRetrieverCli from 'https://cdn.skypack.dev/@robb_j/golden-retriever-cli';
</script>

README

Golden Retriever

Your handy searchable companion, index your projects and quickly search them

Features

  • Creates an index of your personal projects, repos and organisations
  • Provides a search to query your content and quickly navigate to them

Development

Setup with robb-j/ts-node-base

Features

  • Multi-stage docker build to install, test and deploy
  • Testing setup with mocha, chai & nyc
  • Linting setup with tslint

Dev Commands

# Lint the web & test directories
npm run lint

# Run the unit tests
npm test

# Generate coverage
npm run coverage          # outputs to coverage/
npm run coverage-summary  # outputs to terminal

# Watch code with nodemon (restarts on file changes)
npm run watch

# Update version (builds & pushes a new docker image)
npm version ... # --help