Write about deployment and document the API in README.md
- Dominant language
- JavaScript
- Stars
- 60
- Forks
- 217
- PR merge metrics
- No merged PRs in 30d
Description
Every time a branch/pull request is being merged to the master branch, Travis execute the deployment script at`deploy/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](http://54.161.117.62/david) to deliver the data. ([see code](https://github.com/bluzi/name-db/tree/master/api))
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
No contributing guide indexed for this repository
Research direction
Start with README.md, then read deploy/deploy.collections.js and the code under api to understand the deployment and data flow. Use issue #198 for local API-running details. Done means the README explains deployment, the MySQL-backed API, and how to run the API locally.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, mysql
- Domain
- backend, databases, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100