Installing logx-reader (For Development)

Requirements

Install

Clone the logx-reader repository.

Note

We suggest developing the logx-reader on a Linux environment under the ~/repos/clu-ling directory. This documentation contains commands which run under these assumptions.

To run the visualizer alongside the logx-reader REST API, clone the odin-tuorial repository and change the docker-compose.yml file to:

version: "3.8"
services:
  frontend:
    image: parsertongue/odin-tutorial:local
    build:
      context: .
      dockerfile: Dockerfile
    restart: unless-stopped
    ports:
      - "8880:7777"
    env_file:
      - ./.env
    environment:
      ODIN_API_BASE_URL: http://0.0.0.0:9000/api

Running

To run the logx-reader REST API in development mode, run the following command under the logx-reader directory to redirect to the external grammars:

RULES_PREFIX=file://$HOME/repos/clu-ling/logx-reader/reader/grammars/logx sbt web

Open your browser to localhost:9000.

Note

If you didn't clone the logx-reader repository under the recomended directory, change the RULES_PREFIX path to reflect your local path.

To run the visualizer without docker, you'll need a version of Node installed. Clone the odin-tutorial repo run the command from the project root:

npm install && npm run start

Open your browser to localhost:7777/playground.