{"id":15297518,"url":"https://github.com/diegovictor/named-api","last_synced_at":"2026-03-02T13:12:49.538Z","repository":{"id":65187791,"uuid":"453695387","full_name":"DiegoVictor/named-api","owner":"DiegoVictor","description":"Foxbox Week Challenge #2. API that generates names based on a sample.","archived":false,"fork":false,"pushed_at":"2025-03-13T12:30:45.000Z","size":87,"stargazers_count":2,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-07T00:35:59.818Z","etag":null,"topics":["api","foxbox","generator","go","golang","name-generator","named","py","python"],"latest_commit_sha":null,"homepage":"https://named-api.onrender.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/DiegoVictor.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-01-30T14:00:41.000Z","updated_at":"2025-03-13T12:30:50.000Z","dependencies_parsed_at":"2024-01-12T16:51:11.312Z","dependency_job_id":"c7533d4c-7379-411d-b20f-73238fdb3d0f","html_url":"https://github.com/DiegoVictor/named-api","commit_stats":{"total_commits":71,"total_committers":1,"mean_commits":71.0,"dds":0.0,"last_synced_commit":"43f143ada6bfc92683f32d1b15168489d56269ea"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/DiegoVictor/named-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DiegoVictor%2Fnamed-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DiegoVictor%2Fnamed-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DiegoVictor%2Fnamed-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DiegoVictor%2Fnamed-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DiegoVictor","download_url":"https://codeload.github.com/DiegoVictor/named-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DiegoVictor%2Fnamed-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271658664,"owners_count":24798136,"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","status":"online","status_checked_at":"2025-08-22T02:00:08.480Z","response_time":65,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["api","foxbox","generator","go","golang","name-generator","named","py","python"],"created_at":"2024-09-30T19:18:04.994Z","updated_at":"2026-03-02T13:12:49.484Z","avatar_url":"https://github.com/DiegoVictor.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [API] Named\n[![GitHub Workflow Status (branch)](https://img.shields.io/github/actions/workflow/status/DiegoVictor/named-api/config.yml?style=flat-square\u0026logo=github)](https://github.com/DiegoVictor/named-api/actions)\n[![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/diegovictor/named-api?style=flat-square)](https://go.dev/)\n[![coverage](https://img.shields.io/codecov/c/gh/DiegoVictor/named-api?logo=codecov\u0026style=flat-square)](https://codecov.io/gh/DiegoVictor/named-api)\n[![MIT License](https://img.shields.io/badge/license-MIT-green?style=flat-square)](https://raw.githubusercontent.com/DiegoVictor/named-api/main/LICENSE)\n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)\u003cbr\u003e\n[![Run in Insomnia}](https://insomnia.rest/images/run.svg)](https://insomnia.rest/run/?label=Named\u0026uri=https%3A%2F%2Fraw.githubusercontent.com%2FDiegoVictor%2Fnamed-api%2Fmain%2FInsomnia_2024-12-07.json)\n\nResponsible for provide data to the [web](https://github.com/DiegoVictor/named-web) front-end. Generates names based on preseted datasets (list of example names), but you can upload a custom dataset (it must have at least 23 names). Was utilized the Markov Chain algorithm to generate the names, a custom script was created based on this article: [Generating Startup names with Markov Chains](https://towardsdatascience.com/generating-startup-names-with-markov-chains-2a33030a4ac0).\n\nLive Demo: https://named-api.onrender.com/\n\n## Table of Contents\n* [Requirements](#requirements)\n* [Usage](#usage)\n  * [Routes](#routes)\n    * [Requests](#requests)\n* [Running the tests](#running-the-tests)\n  * [Coverage report](#coverage-report)\n\n# Requirements\n* [Go](https://go.dev/)\n\n# Usage\nTo start up the app run:\n```\n$ go run .\n```\nOr:\n```\ngo run main.go\n```\nOr even:\n```shell\n$ ./scripts/run.sh\n```\n\n## Routes\n|route|HTTP Method|params|description\n|:---|:---:|:---:|:---:\n|`/datasets`|GET| - |Retrieve available datasets.\n|`/names`|GET|`dataset` query parameter.|Generate names for the dataset provided.\n|`/feedbacks`|POST|Body with an array of feedbacks with `name` and `value`.|Save good feedbacks\n|`/upload`|POST|Body with dataset [form data](https://developer.mozilla.org/docs/Web/API/FormData) (See insomnia file for good example).|Create a custom dataset.\n\n\n### Requests\n* `POST /feedbacks`\n\nRequest body:\n```\n[\n  {\n    \"name\": \"Jordan\",\n    \"value\": 1\n  }\n]\n```\n\n* `POST /upload`\n\nRequest body:\n```\n\"file\"=\u003cfile\u003e\n```\n\n# Running the tests\nTo run the projects' tests the app:\n```shell\n$ ./scripts/test.sh\n```\nOr:\n```shell\n$ go test ./tests/... -cover -coverpkg=./controllers,./helpers -coverprofile=coverage-report.out\n```\n\n## Coverage report\nYou can see the coverage report on root folder `coverage-report.out`. They are automatically created after the tests run (with you used the command above).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdiegovictor%2Fnamed-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdiegovictor%2Fnamed-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdiegovictor%2Fnamed-api/lists"}