bluzi/name-db

Write about deployment and document the API in README.md

Open

#197 geöffnet am 27. Okt. 2017

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (220 Forks)github user discovery
good first issuehacktoberfesthelp wanted

Repository-Metriken

Stars
 (60 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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

Contributor Guide

Research-Richtung
Lese das Deployment Skript in deploy/deploy.collections.js und den API Code unter api/, um den Deployment Prozess und die Verbindung der API zur MySQL Datenbank zu verstehen. Aktualisiere dann die README.md mit einem Abschnitt, der das Deployment und die API Nutzung erklärt, einschließlich der lokalen Ausführung der API, wie in Issue #198 referenziert.
Tech Stack
javascriptnodejsmysql
Domain
backenddocumentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitNode.js
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85