Skip to content

Latest commit

 

History

History
74 lines (55 loc) · 2.67 KB

README.md

File metadata and controls

74 lines (55 loc) · 2.67 KB
Raw

Build Status

name-db

name-db is a collection of names in all languages. Our goal is to collect as much data as we can, and to provide an open-source free API for name translations.

Specs

name-db currently stores only first names.

Each name is stored in a JSON file, located in collection/. The following is the structure of a name file:

collection/{lowercase name}.json:

{
    "name": "", // English name, lowercase, coresponding to the filename
    "meaning": "", // The meaning of the name, in English
    "aliases": [], // An array of lowercase alias names, such as: richard -> dick, daniel -> dan, etc.
    "translations": {
        "{lowercase ISO-639-3 language code}": "{translation}" 
    },
    "sex": "" // (Optional) Gender of the name. Use a single, lowercase letter: `m` for male, `f` for female or `u` for unisex (names that can be male or female).
}

Example:

collections/jonathan.json

{
    "name": "jonathan",
    "meaning": "Hebrew for \"YHWH has given\"",
    "aliases": [
        "johnathan",
        "john",
        "yonathan"
    ], 
    "translations": {
        "heb": "ג'ונתן" 
    },
    "sex": "m"
}

The language codes are ISO 639-3 codes. For a list of language codes, please see: https://en.wikipedia.org/wiki/List_of_ISO_639-3_codes

Note that everything except the translations should be in English.

API

The API is still under development, but you can see the latest stable version here Note that you shouldn't use it in production yet - We still don't have enough data, and the endpoint is running on a cheap machine. Feel free to view the code, suggest features or create new features with a pull request - we're looking for help with the API.

Contribution (Easy PR, large impact!)

Making a contribution is real easy - just read the specs, and do one of these:

  • Add your/a name (if it doesn't exist yet)
  • Add a translation to existing name
  • Add meanings to existing names
  • Correct translations / meanings
  • Come up with a way we can do things better, and create an issue

Also, feel free to take a few aliases that doesn't have a file, and create their files.

Just fork the repository, do one of the tasks above, make a pull request and we'll approve it.

License

This project is licensed under the MIT License.