Skip to content

proycon/frog_webservice

Repository files navigation

Project Status: Active – The project has reached a stable, usable state and is being actively developed.

Frog Webservice

Website: https://languagemachines.github.io/frog

This is the webservice for Frog, powered by CLAM. It offers a RESTful API as well as a web-interface for human end-users.

Installation

Development

Clone this repository, create a virtual environment and install the webservice as follows:

$ python3 -m venv env
$ . env/bin/activate
$ ./startserver_development.sh

Navigate to http://localhost:8080.

Note that for this to work, Frog must already be installed on your system (and in your $PATH).

Production

A Dockerfile is provided for deployment in production environments.

From the repository root, build as follows:

$ docker build -t proycon/frog_webservice .

Consult the Dockerfile for various build-time parameters that you may want to set for your own production environment.

When running, mount the path where you want the user data stored into the container, a directory frog will be created here:

$ docker run -p 8080:80 -v /path/to/data/dir:/data proycon/frog_webservice