{"id":15096062,"url":"https://github.com/mrinjamul/words-zen","last_synced_at":"2026-02-03T03:37:25.352Z","repository":{"id":64301978,"uuid":"447741639","full_name":"mrinjamul/words-zen","owner":"mrinjamul","description":"Words as a Service.","archived":false,"fork":false,"pushed_at":"2022-06-30T02:06:16.000Z","size":175,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-01T17:44:20.002Z","etag":null,"topics":["gin","go","service"],"latest_commit_sha":null,"homepage":"https://wordsz.herokuapp.com","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mrinjamul.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"mrinjamul","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":"https://www.paypal.me/mrinjamul"}},"created_at":"2022-01-13T20:24:47.000Z","updated_at":"2022-04-02T06:37:41.000Z","dependencies_parsed_at":"2023-01-15T09:31:21.690Z","dependency_job_id":null,"html_url":"https://github.com/mrinjamul/words-zen","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrinjamul%2Fwords-zen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrinjamul%2Fwords-zen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrinjamul%2Fwords-zen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrinjamul%2Fwords-zen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mrinjamul","download_url":"https://codeload.github.com/mrinjamul/words-zen/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245852800,"owners_count":20683095,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["gin","go","service"],"created_at":"2024-09-25T15:45:15.161Z","updated_at":"2026-02-03T03:37:25.293Z","avatar_url":"https://github.com/mrinjamul.png","language":"Go","funding_links":["https://github.com/sponsors/mrinjamul","https://www.paypal.me/mrinjamul"],"categories":[],"sub_categories":[],"readme":"# Words Zen\n\nWords as a service written in Go.\n\n---\n\n\u003e A simple API to generate unique randomized words \u0026 phrases.\n\n## Usage\n\n### Word Types\n\nwords-zen supports 8 word types that can be used to form a phrase:\n\n- `adjective`\n- `adverb`\n- `animal`\n- `bodyPart`\n- `gerund`\n- `noun`\n- `pluralNoun`\n- `verb` (imperative mood)\n\n### Additional Features\n\nWhen placed at the beginning of a phrase, the word `a` will be transformed into `an` if the second word in the phrase begins with a vowel (i.e. _a/an squid/octopus_). You can also use any additional words to form a phrase like _the_, _it_, _is_, etc.\n\n### Forming a phrase\n\nTo form a phrase, connect the type(s) of words you want with a comma. For example, to form a phrase consisting of a verb, `the`, and a plural noun, you would use the following:\n`the,pluralNoun,is,gerund` for the slug API or `the $pluralNoun is $gerund` for the query API.\n\n## API\n\n### Slug API\n\nMake a `GET` request to [http://localhost:3000/api/PHRASE](http://localhost:3000/api), where PHRASE is the type of phrase desired.\n\n```shell script\ncurl --request GET \\\n  --url 'http://localhost:3000/api/a $adjective $noun'\n```\n\n### Query API\n\nor, `POST` to [http://localhost:3000/api](http://localhost:3000/api) with a query of the type of phrase desired.\n\n```shell script\ncurl --request POST \\\n    --url http://localhost:3000/api \\\n    --header 'content-type: application/json' \\\n    --data '{\n  \t  \"query\": \"the $pluralNoun is $gerund\"\n    }'\n```\n\n## Installation\n\nClone it from GitHub,\n\n```bash\ngit clone https://github.com/mrinjamul/words-zen.git\n```\n\nAnd Run by,\n\n```bash\n    cd words-zen\n    go mod download\n    go build\n    ./words-zen\n```\n\n## Technology Stack\n\nTechnologies used:\n\n- [Golang](https://golang.org/): [Go](https://golang.org/)\n- [Gin](https://github.com/gin-gonic/gin)\n- HTML,CSS and JavaScript\n\n## License\n\nopen-sourced under MIT license [MIT](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrinjamul%2Fwords-zen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmrinjamul%2Fwords-zen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrinjamul%2Fwords-zen/lists"}