Skip to content

didmar/jamdict-api

Repository files navigation

Jamdict API

API for Japanese language study, based on Jamdict library.

Added some useful routes for my project Kanji game

How to install

The easiest way is to use the provided Dockerfile:

make docker
docker run -p 127.0.0.1:9000:9000 jamdictapi:latest

Otherwise, to build locally on a Ubuntu/Debian machine (tested with Ubuntu 20.04):

First install Python >=3.7, PIP and required dependencies

sudo apt install python3.7-dev python3-pip
python3.7 -m pip install pip
python3 -m pip install -r requirements.txt --user

Run the following script to download required data files

./download_data.sh

Finally run this script to start the API

./run.sh

Go to http://127.0.0.1:9000/docs to check the documentation.