Skip to content

Latest commit

 

History

History
74 lines (47 loc) · 2.23 KB

readme.md

File metadata and controls

74 lines (47 loc) · 2.23 KB
Raw

RSyntaxTree Web UI

This is an web UI source code package for RSyntaxTree, a command line app to generate linguistic syntax trees. With this, you can run your local copy of RSyntaxTree on Docker installed on your own computer.

Changelog

  • [December, 2022] Docker Hub images are available
  • [December, 2022] Base Docker image is changed to Alpine
  • [November, 2022] Minified JS and CSS are included

You can setup a docker container using either downloading a Docker Hub image or building a Docker image locally.

Usage 1: Use Docker Hub (Recommended)

Setup

  1. Download and install Docker Desktop (Windows / MacOS / Linux).
  2. Start Docker Desktop.

Start Server

  1. Run the following command in a terminal and set up the Docker image. This may take a while the first time.
docker run -it -p 8080:8080 yohasebe/rsyntaxtree

When you have INFO -- : worker=0 ready shown in the terminal, the setup is complete.

  1. Access the folloing URL in a web browser
http://localhost:8080
  1. You can stop the server with Ctrl + c in the terminal

Usage 2: Build Docker Image Locally

Setup

  1. Download and install Docker Desktop (Windows / MacOS / Linux).
  2. Start Docker Desktop.
  3. Clone this repository, or download and extract the ZIP package.
  4. Open a terminal and go to the project root folder.
  5. Run the following command and build the Docker image. This may take a while.
docker build -t rsyntaxtree .

Start Server

  1. Make the server script executable.
chmod a+x ./bin/start_server
  1. Start RSyntaxTree server.
./bin/start_server
  1. Access the folloing URL in a web browser
http://localhost:8080
  1. You can stop the server with Ctrl + c in the terminal

NOTE: Setup tutorial is also available in Chinese (thanks to Kent)