README.md

LoKal-AnD-Global-Debugging-and-Monitoring

What

Local server exposed via ngrok to log request from an external source or host file for an external source

Why

First case

• Needed to help someone debug some issue which only happened on the iOS release version of an app and wi didn't know how to get the JS logs.

Second case

• To test the setup of universal link of an app I needed to expose the config file to Apple before releasing it in production (cf : https://blog.bam.tech/developer-news/test-your-universal-links-locally-ios)

How

Start the server

git clone https://github.com/LouisKraemer/local-debugger.git

cd LoKal-AnD-Global-Debugging-and-Monitoring

yarn

yarn start

Start ngrok

ngrok # You can bind it to a static domain that ngrok gives you by default  ngrok http --domain=STATIC_DOMAIN

To test, you can make a POST

curl -d '{"key":"value"}' -H "Content-Type: application/json" -X POST YOUR_NGROK_URL

And you should see that in your console

{ key: 'value' }

You can now make a POST call from wherever you want to help you debug or host a file for an external source.

Usage from JS app (React/React Native...)

1. Create a logger.ts file with the following content:

const DEBUGGER_REMOTE_API = "YOUR_NGROK_URL"; //Replace with your ngrok endpoint

export const Logger = {
  debug: (message: string): void => {
    fetch(DEBUGGER_REMOTE_API, {
      method: "POST",
      headers: {
        Accept: "application/json",
        "Content-Type": "application/json"
      },
      body: JSON.stringify({ log: message })
    });
  }
};

2. Call from within your app in place of console.log:

import { Logger } from 'logger';

...

Logger.debug(`My debugging statement with a dynamic ${variable}`)

Contributors

Guitoof

AntoineDoubovetzky

LouisKraemer