bluzi/name-db

Write about deployment and document the API in README.md

Open

#197 ouverte le 27 oct. 2017

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)JavaScript (220 forks)github user discovery
good first issuehacktoberfesthelp wanted

Métriques du dépôt

Stars
 (60 stars)
Métriques de merge PR
 (Métriques PR en attente)

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

Guide contributeur

Direction de recherche
Lisez le script de déploiement dans deploy/deploy.collections.js et le code de l'API sous api/ pour comprendre le processus de déploiement et comment l'API se connecte à la base de données MySQL. Ensuite, mettez à jour le README.md avec une section expliquant le déploiement et l'utilisation de l'API, y compris comment exécuter l'API localement comme mentionné dans le problème #198.
Stack technique
javascriptnodejsmysql
Domaine
backenddocumentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitNode.js
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85