bluzi/name-db

Write about deployment and document the API in README.md

Open

#197 opened on Oct 27, 2017

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (220 forks)github user discovery
good first issuehacktoberfesthelp wanted

Repository metrics

Stars
 (60 stars)
PR merge metrics
 (PR metrics pending)

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

Contributor guide

Research direction
Read the deployment script at deploy/deploy.collections.js and the API code under api/ to understand the deployment process and how the API connects to the MySQL database. Then update the README.md with a section explaining deployment and API usage, including how to run the API locally as referenced in issue #198.
Tech stack
javascriptnodejsmysql
Domain
backenddocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85