logstart is a simple web server that logs all requests in detail to the console or a file. This includes the HTTP method, request path, headers, parameters, request payload, IP address, and timestamp.

When integrating with external systems such as payment gateways, it is often crucial to understand the actual data structure of their callbacks. Although it is relatively easy to set up our own web application to catch the response, there are scenarios where we don't have our web application deployed yet but need to start writing the backend code and want a quick way to fire up a server.

In such cases, running npx logstart can be a quick and easy way to start a server that logs all incoming requests.

• Logs detailed request information:
  • HTTP method
  • Request path
  • Headers
  • Parameters
  • Request payload
  • IP address
  • Timestamp
• Outputs logs to the console and optionally to a specified file.
• Automatically increments the port number if the specified port is occupied.
• Customizable response message.

To start the server, simply run:

npx logstart

By default, the server will run on port 8999. If this port is occupied, it will automatically increment the port number until it finds an available one.

• --output, -o: Specify a file to save the log output.
• --port, -p: Specify the port for the web service. Defaults to 8999.
• --response, -r: Specify a custom response message. Defaults to {"status": "ok"}.

npx logstart

npx logstart --output=logfile.txt

npx logstart --port=8080

npx logstart --response='{"message": "Hello World"}'

When a request is made to the server, the log output is formatted with detailed information:

===================== 2024-06-12T12:34:56.789Z =====================
[GET] /
--------------------------------------------------------------------
[IP] ::1

[HEADERS]
{
  "host": "localhost:8999",
  "user-agent": "curl/7.64.1",
  ...
}

[PARAMS]
{}

[QUERY]
{}

[BODY]
{}

This project is licensed under the MIT License.