Doakes, a good looking proxy logger

🇧🇷 Português

Um logger belo e simples que roda na linha de comando com apenas 1 script, ideal para registrar a atividade em sua aplicação durante o ambiente de desenvolvimento.

🇺🇸 English

A simple and pretty logger tool that runs in your command line with just 1 script, perfect for logging the activity on your application in it's development stage.

Preview

Running the tool

Features

• Quick and easy setup
• Colored logging messages with method, url, response status code and time metrics

Pre-Requisites

• Node v18 +

Getting Started

• Installing the package

The recommended way to download this tool is by adding the -g flag for a global installation in your computer, as such:

npm i doakes-logger -g

How it Works

By running doakes you create a local proxy web server that runs in your own machine's ip address and hosts your application, so all you have to do is:

1. Run your web application locally,
2. Setup doakes with an input port (the port where your applications is currently running ) and an output port (the port where you wish to run doakes)

By the end of this you'll have a "mirrored" version of your app running on the desired output port, which then you'll be able to access in your browser of choice and see the logging details of all HTTP requisitions made in the output address, in your CLI.

Running the tool

• Start command for running the server with default values:

doakes

Running this command alone will start the proxy server with the default localhost port numbers of 3000 for the input and 3001 for the listening port output

• Start command for running the server with custom values:

Customization Flags

| Flag | Short | Description | | ---------- | ----- | -------------------------------------------------------------------------------------------------------------------------------------------------- | | --input | -i | Expects a number or string argument, serving as the port in your local machine where the application you wish to log is currently running. | | --output | -o | Expects a number or string argument, representing the localhost PORT where the proxied version of your application will be running. |

doakes -i <your Application's PORT> -o <output PORT for the Logger>

This command will start the proxy server on your machine's local ip, logging the url passed through the --input or -i flag, and you'll be ale to see the logging details on your CLI.