egasimov/aznum2words

[AZ] Azərbaycan dilində ədədlərin sözlə yazılış təsviri üçün Go dilində yazılmış kitabxana. [EN] The library for converting numbers to words in the Azerbaijan language written in Go.

aznum2words's Issues

Feature: Run project as web app | Introduce Web API

As for now, AzNum2Words can be utilized in two ways:

• Library (via importing into go-projects)
• CLI app(build binaries and executing it)

For the people who have no experience with Go language or their already existing system is not compatible to integrate via go library, it would be nice to have another option to use AzNum2Words in somehow.

The proposed solution is ability to run AzNum2Words as microservice and having its well-defined API. So as the result, consumers will able to use functionalities offered by AzNum2Words via calling its exposed API, basically endpoints.

Initially, it was thought that developing web app exposing REST API due to its simplicity and having wider range of uses in the industry. (gPRC support can be added later on demand)

Simple saying, new feature is to develop web app exposing AzNum2Words functionalities as REST API to consumers.

There are few requirements for new feature that need to be considered while developing it.

1. Prepare open-spec contract based on OpenAPI 3.0
   1.1. Code-generator
   tools such as oapi-codegen can be used to generate models, server-side codes to minimize human errors.

2. It needs to be highly configurable via config file, environment variables.( e.g godotenv) [MUST]

3. Able to run web-app both on locally and containerized environment. [MUST]

4. Write tests to increase maintainability and code quality [MUST]

5. Observability purpose requirements [[DESIRED]]
   5.1. Add Health check purpose endpoints
   5.2. Expose metrics
   5.3. Do properly error handling, logging

[Feat] Add floating point number support

[Feat] Support for conversion of negative whole number to word

As a user, I want to convert negative numbers to words.

Examples
Given: -81
Expected: mənfi səksən bir

Given: -761
Expected: mənfi yüz altmış bir

Bug: CLI app installation command described in Readme does not work as expected

Description
Installing the CLI application using the provided command does not work as expected. The command must specify a package that points to the cli, not the executable file.

Current:
go install github.com/egasimov/aznum2words/cmd/cliapp/aznum2words-cli@latest

Should be:
go install github.com/egasimov/aznum2words/cmd/cliapp@latest

In order for the command to work as expected the name of the cli app package also needs to be changed.

To Reproduce

1. Execute the following command:
   go install github.com/egasimov/aznum2words/cmd/cliapp/aznum2words-cli@latest

2. Result:
   go: github.com/egasimov/aznum2words/cmd/cliapp/aznum2words-cli@latest: module github.com/egasimov/aznum2words@latest found (v0.1.0), but does not contain package github.com/egasimov/aznum2words/cmd/cliapp/aznum2words-cli

Expected behavior
The command installed the binaries into $GOPATH/bin properly, and command should work with provided examples.

Desktop:

• MacOS Monterey 12.2
• Go version go1.19.4