Gazetteer

Simple text markup API based on gazetteers with management UI

License	MIT
GroupId	io.committed
ArtifactId	gazetteer
Last Version	1.3.0
Release Date	Sep 1, 2020
Type	jar
Description	Gazetteer Simple text markup API based on gazetteers with management UI
Project URL	http://github.com/commitd/gazetteer
Project Organization	Committed
Source Code Management	http://github.com/commitd/gazetteer

Download gazetteer

Filename	Size
gazetteer-1.3.0.pom
gazetteer-1.3.0.jar	1 MB
gazetteer-1.3.0-sources.jar	14 KB
gazetteer-1.3.0-javadoc.jar	493 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/io.committed/gazetteer/ -->
<dependency>
    <groupId>io.committed</groupId>
    <artifactId>gazetteer</artifactId>
    <version>1.3.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/io.committed/gazetteer/
implementation 'io.committed:gazetteer:1.3.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/io.committed/gazetteer/
implementation ("io.committed:gazetteer:1.3.0")

Apache Buildr

'io.committed:gazetteer:jar:1.3.0'

Apache Ivy

<dependency org="io.committed" name="gazetteer" rev="1.3.0">
  <artifact name="gazetteer" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='io.committed', module='gazetteer', version='1.3.0')
)

Scala SBT

libraryDependencies += "io.committed" % "gazetteer" % "1.3.0"

Leiningen

[io.committed/gazetteer "1.3.0"]

Dependencies

compile (6)

Group / Artifact	Type	Version
org.ahocorasick : ahocorasick	jar	0.4.0
org.springframework.boot : spring-boot-starter-web	jar	2.3.1.RELEASE
org.springframework.boot : spring-boot-starter-data-jpa	jar	2.3.1.RELEASE
org.springdoc : springdoc-openapi-ui	jar	1.4.1
org.projectlombok : lombok	jar	1.18.12
com.google.guava : guava	jar	27.0-jre

runtime (1)

Group / Artifact	Type	Version
com.h2database : h2	jar	1.4.200

test (1)

Group / Artifact	Type	Version
org.springframework.boot : spring-boot-starter-test	jar	2.3.1.RELEASE

Project Modules

There are no modules declared in this project.

Committed Gazetteer

Committed's Gazetteer offers a simple API for performing text markup using a Gazetteer. The Gazetteer is often overlooked in favour of ML base NLP solutions but for high value targets a simple gazetteer can form an important part or a broader NLP extraction strategy. This service also has a user interface for configuring the Gazetteer so it can be done by none developers.

🚀 Quickstart

Use the pre-build docker container:

docker run -p 8080:8080 committed/gazetteer

You can configure the gazetteer using the UI on http://localhost:8080 and checkout the API at http://localhost:8080/swagger-ui/index.html

💻 Development

We use maven to build the project using:

mvn clean package 

The server is written in java using Spring Boot and the UI is Typescript with React.

This will build the server, ui and Docker image.

For UI development, in src/main/app you will find the usual node package.json with scripts for, build, start, test and storybook as well as some other utility scripts. The scripts can be used while developing the UI, example below, but the main maven build will take care of building and packaging the UI into the jar. Not for full function during UI development you should also run the server.

yarn build

We use Storybook to develop and document the components, this is run in development using

yarn storybook

🤖 CI

Pull requests go through CI checks using Drone. Use version tags on master to deploy to Docker hub, release to maven central is currently manual, using:

mvn deploy -P release

©️ License

MIT - © Committed Software 2020 https://committed.io

Committed

Versions

Version
1.3.0 Sep 1, 2020
1.2.0 Aug 10, 2020
1.1.0 Jul 24, 2020
1.0.0 Jul 23, 2020