Sign inSign up

jsahleen/cldr-service

By jsahleen

•Updated almost 4 years ago

CLDR service

Image
1

1.4K

jsahleen/cldr-service repository overview

⁠cldr-service

Proof of concept implementation for a CLDR web service. Allows dynamic loading of CLDR data across multiple locales, with element and content filtering. The current implementation provides publicly accessible data for number systems, currencies, units, languages, scripts, territories, variants, extensions, calendars, relative time formats, time zones and dynamically contructed locales.

⁠Local Setup

To use the service locally, follow these steps:

  1. Install Docker Desktop⁠ for Mac or Windows.

  2. Create a new directory and add a docker-compose.yml file with the following content

version: '3'
services:
  cldr-db:
    container_name: cldr-db
    image: mongo
    volumes:
      - ./data:/data/db
    ports:
      - "27017:27017"
  cldr-service:
    container_name: cldr-service
    image: jsahleen/cldr-service
    restart: always
    ports:
      - "${CLDR_PORT}:${CLDR_PORT}"
      - "${CLDR_SSL_PORT}:${CLDR_SSL_PORT}"
    depends_on:
      - cldr-db
    volumes:
      - ./cert:/usr/src/app/cert:ro
    env_file:
      - .env
  1. Add a .env file with overrides for the following default values:
CLDR_ROOT_USER_EMAIL="[email protected]"
CLDR_ROOT_USER_PASSWORD="Pa$$w0rd123"
CLDR_JWT_SECRET="b2upnzpr/XkBCpP"
CLDR_CERT_PATH="../cert/cldr-service.pem"
CLDR_KEY_PATH="../cert/cldr-service-key.pem"
CLDR_SSL_PORT=8090
CLDR_PORT=3000

(If you want to change the CLDR version and tier you need to clone the repository and pass CLDR_VERSION and CLDR_TIER as arguments to docker build.)

To run the service using SSL, create a cert directory at the same level as your .env file and put your cert file and key in this directory. The cert directory is loaded as a volume in the docker-compose file. Make sure you specify the required CLDR_SSL_PORT, CLDR_CERT_PATH and CERT_KEY_PATH variable in your .env file. The paths for CLDR_CERT_PATH and CLDR_KEY_PATH should start with .. because it is relative to the built directory when compiled.

Ports for secure and insecure http connections can now be specified in the .env file.

  1. Run docker compose up -d to start the service.

  2. The first time you use the service you will need to seed the database with data taken from cldr-json. To do this, run:

docker compose exec cldr-service yarn seed

Seeding the database will take some time, but it only needs to be done once. If you want to re-seed the data for just one service, you can do so by using docker compose exec cldr-service yarn seed [service].

⁠USAGE

The following endpoints are currently implemented:

  • AUTH

    • POST /auth
    • POST /auth/refresh-token

  • USERS

    • GET admin/users
    • POST admin/users
    • GET admin/users/:id
    • PUT admin/users/:id
    • PATCH admin/users/:id
    • DELETE admin/users/:id

  • NUMBER SYSTEMS

    • GET public/numbers?locales={locales}&systems={systems}&filters={filters}&page={page}&limit={limit}
    • GET public/numbers/:system?locales={locales}&filters={filters}&page={page}&limit={limit}
    • GET admin/numbers?locales={locales}&systems={systems}&filters={filters}&page={page}&limit={limit}
    • POST admin/numbers
    • GET admin/numbers/:id
    • PUT admin/numbers/:id
    • PATCH admin/numbers/:id
    • DELETE admin/numbers/:id

  • CURRENCIES

    • GET public/currencies?locales={locales}&codes={codes}&filters={filters}&page={page}&limit={limit}
    • GET public/currencies/:code?locales={locales}&filters={filters}&page={page}&limit={limit}
    • GET admin/currencies?locales={locales}&codes={codes}&filters={filters}&page={page}&limit={limit}
    • POST admin/currencies
    • GET admin/currencies/:id
    • PUT admin/currencies/:id
    • PATCH admin/currencies/:id
    • DELETE admin/currencies/:id

  • UNITS

    • GET public/units?locales={locales}&tags={tags}&filters={filters}&page={page}&limit={limit}
    • GET public/units/:tag?locales={locales}&filters={filters}&page={page}&limit={limit}
    • GET admin/units?locales={locales}&tags={tags}&filters={filters}&page={page}&limit={limit}
    • POST admin/units
    • GET admin/units/:id
    • PUT admin/units/:id
    • PATCH admin/units/:id
    • DELETE admin/units/:id

  • LANGUAGES

    • GET public/languages?locales={locales}&tags={tags}&filters={filters}&page={page}&limit={limit}
    • GET public/languages/:tag?locales={locales}&filters={filters}&page={page}&limit={limit}
    • GET admin/languages?locales={locales}&tags={tags}&filters={filters}&page={page}&limit={limit}
    • POST admin/languages
    • GET admin/languages/:id
    • PUT admin/languages/:id
    • PATCH admin/languages/:id
    • DELETE admin/languages/:id

  • SCRIPTS

    • GET public/scripts?locales={locales}&tags={tags}&filters={filters}&page={page}&limit={limit}
    • GET public/scripts/:tag?locales={locales}&filters={filters}&page={page}&limit={limit}
    • GET admin/scripts?locales={locales}&tags={tags}&filters={filters}&page={page}&limit={limit}
    • POST admin/scripts
    • GET admin/scripts/:id
    • PUT admin/scripts/:id
    • PATCH admin/scripts/:id
    • DELETE admin/scripts/:id

  • TERRITORIES

    • GET public/territories?locales={locales}&tags={tags}&filters={filters}&page={page}&limit={limit}
    • GET public/territories/:tag?locales={locales}&filters={filters}&page={page}&limit={limit}
    • GET admin/territories?locales={locales}&tags={tags}&filters={filters}&page={page}&limit={limit}
    • POST admin/territories
    • GET admin/territories/:id
    • PUT admin/territories/:id
    • PATCH admin/territories/:id
    • DELETE admin/territories/:id

  • VARIANTS

    • GET public/variants?locales={locales}&tags={tags}&filters={filters}&page={page}&limit={limit}
    • GET public/variants/:tag?locales={locales}&filters={filters}&page={page}&limit={limit}
    • GET admin/variants?locales={locales}&tags={tags}&filters={filters}&page={page}&limit={limit}
    • POST admin/variants
    • GET admin/variants/:id
    • PUT admin/variants/:id
    • PATCH admin/variants/:id
    • DELETE admin/variants/:id

  • EXTENSIONS

    • GET public/extensions?locales={locales}&keys={keys}&filters={filters}&page={page}&limit={limit}
    • GET public/extensions/:key?locales={locales}&filters={filters}&page={page}&limit={limit}
    • GET admin/extensions?locales={locales}&keys={keys}&filters={filters}&page={page}&limit={limit}
    • POST admin/extensions
    • GET admin/extensions/:id
    • PUT admin/extensions/:id
    • PATCH admin/extensions/:id
    • DELETE admin/extensions/:id

  • LOCALES

    • GET public/locales?locales={locales}&tags={tags}&filters={filters}&page={page}&limit={limit}
    • GET public/locales/:tag?locales={locales}&filters={filters}&page={page}&limit={limit}
    • GET admin/locales?locales={locales}&tags={tags}&filters={filters}&page={page}&limit={limit}
    • POST admin/locales
    • GET admin/locales/:id
    • PUT admin/locales/:id
    • PATCH admin/locales/:id
    • DELETE admin/locales/:id

  • CALENDARS

    • GET public/calendars?locales={locales}&calendars={calendars}&filters={filters}&page={page}&limit={limit}
    • GET public/calendars/:calendar?locales={locales}&filters={filters}&page={page}&limit={limit}
    • GET admin/calendars?locales={locales}&calendars={calendars}&filters={filters}&page={page}&limit={limit}
    • POST admin/calendars
    • GET admin/calendars/:id
    • PUT admin/calendars/:id
    • PATCH admin/calendars/:id
    • DELETE admin/calendars/:id

  • RELATIVE TIME

    • GET public/relative-time?locales={locales}&formats={formats}&filters={filters}&page={page}&limit={limit}
    • GET public/relative-time/:format?locales={locales}&filters={filters}&page={page}&limit={limit}
    • GET admin/relative-time?locales={locales}&formats={formats}&filters={filters}&page={page}&limit={limit}
    • POST admin/relative-time
    • GET admin/relative-time/:id
    • PUT admin/relative-time/:id
    • PATCH admin/relative-time/:id
    • DELETE admin/relative-time/:id

  • ZONES

    • GET public/zones?locales={locales}&zones={zones}&filters={filters}&page={page}&limit={limit}
    • GET public/zones/:zone?locales={locales}&filters={filters}&page={page}&limit={limit}
    • GET admin/zones?locales={locales}&zones={zones}&filters={filters}&page={page}&limit={limit}
    • POST admin/zones
    • GET admin/zones/:id
    • PUT admin/zones/:id
    • PATCH admin/zones/:id
    • DELETE admin/zones/:id

For the all query parameters except page and limit, the expected value is a comma-separated list of elements (e.g., ?locales=en,fr,de). The locales, tags, systems and codes parameters support the corresponding lists of elements in cldr-json. Locales are limited to modern locales. Filters can be any set of paths inside the main element of a data module. Only paths specified in filters are returned. By default, all paths are returned. For number systems, there are additional systems keywords default and native that can be passed. For currencies, there is an additional keyword current. For calendars, there is an additional keyword preferred. The formats for relative-time are standard, short and narrow. Data returned is taken from cldr-core, cldr-numbers-modern, cldr-localenames-modern, cldr-dates and the cldr-cal-* packages.

Tag summary

Content type

Image

Digest

sha256:d8eed504e…

Size

247.1 MB

Last updated

almost 4 years ago

docker pull jsahleen/cldr-service