Skip to content

matchID-project/deces-backend

Repository files navigation

API Personnes Décédées

Build status License: LGPL v3 Docker Pulls

API for people who died in France from 1970.

Features

  • Multiple fields can be used as a filter:
    • First/Last name
    • Birth/Death date
    • Birth/Death location (country, department, city, gps coordinate)
    • Age
    • Sex
  • The API can handle common mistakes in fields thanks to fuzzy matching
  • Bulk process (CSV or bulk JSON) for multiple identities
  • Express framework for REST API
  • OpenAPIv3 documentation automatically generated using TSOA
  • Docker image is published at docker hub using GitHub Actions.

Detailed documentation is available at this swagger page

Installation

Install using docker compose:

make up

Before starting a database has to be charged in elasticsearch. Please refer to dataprep repository.

Project resources

License

Source code has been published using LGPL 3.0.

© 2020 Cristian Brokate, DNUM - SDIT