bluzi/name-db

Write about deployment and document the API in README.md

Open

#197 aperta il 27 ott 2017

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)JavaScript (220 fork)github user discovery
good first issuehacktoberfesthelp wanted

Metriche repository

Star
 (60 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Leggi lo script di distribuzione in deploy/deploy.collections.js e il codice API sotto api/ per comprendere il processo di distribuzione e come l'API si connette al database MySQL. Quindi aggiorna README.md con una sezione che spiega la distribuzione e l'utilizzo dell'API, incluso come eseguire l'API localmente come indicato nell'issue #198.
Tech stack
javascriptnodejsmysql
Dominio
backenddocumentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitNode.js
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85