https://github.com/diegovictor/named-api

Foxbox Week Challenge #2. API that generates names based on a sample.
https://github.com/diegovictor/named-api

api foxbox generator go golang name-generator named py python

Last synced: 24 days ago
JSON representation

Foxbox Week Challenge #2. API that generates names based on a sample.

• Host: GitHub
• URL: https://github.com/diegovictor/named-api
• Owner: DiegoVictor
• License: mit
• Created: 2022-01-30T14:00:41.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-01-12T12:32:09.000Z (10 months ago)
• Last Synced: 2024-10-16T03:22:06.267Z (about 1 month ago)
• Topics: api, foxbox, generator, go, golang, name-generator, named, py, python
• Language: Go
• Homepage: https://named-api.onrender.com/
• Size: 101 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# [API] Named

[![GitHub Workflow Status (branch)](https://img.shields.io/github/actions/workflow/status/DiegoVictor/named-api/config.yml?style=flat-square&logo=github)](https://github.com/DiegoVictor/named-api/actions)

![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/diegovictor/named-api?style=flat-square)

[![coverage](https://img.shields.io/codecov/c/gh/DiegoVictor/named-api?logo=codecov&style=flat-square)](https://codecov.io/gh/DiegoVictor/named-api)

[![MIT License](https://img.shields.io/badge/license-MIT-green?style=flat-square)](https://raw.githubusercontent.com/DiegoVictor/named-api/main/LICENSE)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)


[![Run in Insomnia}](https://insomnia.rest/images/run.svg)](https://insomnia.rest/run/?label=Named&uri=https%3A%2F%2Fraw.githubusercontent.com%2FDiegoVictor%2Fnamed-api%2Fmain%2FInsomnia_2022-02-27.json)

Responsible 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).

Live Demo: https://named-api.onrender.com/

## Table of Contents

* [Requirements](#requirements)

* [Usage](#usage)

  * [Routes](#routes)

    * [Requests](#requests)

* [Running the tests](#running-the-tests)

  * [Coverage report](#coverage-report)

# Requirements

* [Go](https://go.dev/)

# Usage

To start up the app run:

```

$ go run .

```

Or:

```

go run main.go

```

Or even:

```shell

$ ./scripts/run.sh

```

## Routes

|route|HTTP Method|params|description

|:---|:---:|:---:|:---:

|`/datasets`|GET| - |Retrieve available datasets.

|`/names`|GET|`dataset` query parameter.|Generate names for the dataset provided.

|`/feedbacks`|POST|Body with an array of feedbacks with `name` and `value`.|Save good feedbacks

|`/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.

### Requests

* `POST /feedbacks`

Request body:

```

[

  {

    "name": "Jordan",

    "value": 1

  }

]

```

* `POST /upload`

Request body:

```

"file"=

```

# Running the tests

To run the projects' tests the app:

```shell

$ ./scripts/test.sh

```

Or:

```shell

$ go test ./tests/... -cover -coverpkg=./controllers,./helpers -coverprofile=coverage-report.out

```

## Coverage report

You 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).