bluzi/name-db

Write about deployment and document the API in README.md

Open

#197 aberto em 27 de out. de 2017

Ver no GitHub
 (0 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

Every time a branch/pull request is being merged to the master branch, Travis execute the deployment script atdeploy/deploy.collections.js. This script connects to a MySQL database, checks to see what changed in collection/, and updates the database. (removes/changes/adds data, so it'll be exactly like collection/)

The MySQL database from above, is being used by the API to deliver the data. (see code)

I'd love if someone could write about it in the README file (dive into the code to understand more)

More information about how to run the API (for example, how to run it locally): https://github.com/bluzi/name-db/issues/198

Guia do colaborador

Direção de pesquisa
Leia o script de implantação em deploy/deploy.collections.js e o código da API em api/ para entender o processo de implantação e como a API se conecta ao banco de dados MySQL. Em seguida, atualize o README.md com uma seção explicando a implantação e o uso da API, incluindo como executar a API localmente conforme mencionado na issue #198.
Pilha de tecnologia
javascriptnodejsmysql
Domain
backenddocumentation
Tipo Issue
Documentação
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.
1-3 horas
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
GitNode.js
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85