bluzi/name-db

Add features to the API

Open

#198 aberto em 27 de out. de 2017

Ver no GitHub
 (4 comments) (0 reactions) (0 assignees)JavaScript (220 forks)github user discovery
good first issuehacktoberfesthelp wanted

Métricas do repositório

Stars
 (60 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

Currently, all the API can do is to search an exact name/alias in the database and return its meaning and translations. We need more features, such as:

  • Search (/search/:term) - Should return a list of matches by a partial term (Search in both aliases/names)
  • Get translation (/:name/:language) - Should return the translation of :name in :language

Anything else you can think of :)

You can easily run the API just by cloning the repo and run npm install && npm start, then you should be able to browse to http://localhost:3000 and see the API is running. Your clone will connect to the actual production database, however the user supplied there is only able to select, and is limited by its number of queries per hour.

If you need help or have any ideas, feel free to comment here.

Guia do colaborador

Direção de pesquisa
Implemente os dois novos endpoints da API: `/search/:term` para pesquisa parcial de nome/alias, e `/:name/:language` para recuperar uma tradução específica. Atualize o roteador, adicione consultas SQL usando LIKE para pesquisa e teste localmente com a configuração fornecida.
Pilha de tecnologia
javascriptnodejs
Domain
backendapi
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
JavaScriptNode.jsGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75