NOTE: Any manual changes to Github Wiki will be overwritten by push (PR merged) to master branch
Welcome to the Manual/Wiki for the Hapi REST Server Template. These files should updated whenever we merge to master, and be in sync between:
- The README files in the repo,
- The Github Wiki, and
- The generated doc site served when running the server and on github pages
We use a Github Action to accomplish this. The action is executed on merge to the master branch and defined inside of the ./.github/workflows/ directory(github) (along with all other github actions) that calls a script(github) in our scripts/actions directory.
The script retrieves the following markdown files (defined in ./.esdoc.json) and copies them to a temporary directory, then uses the wiki-page-creator-action to update the wiki.
- Setup - dependencies and how to install and start development (eventually production?)
- Entry Point - How we start and setup the server process to handle requests
- Controllers - mappings from url endpoints to methods for handling requests
- Dataservices - classes/methods that connect to external services or datastores
- Helpers - classes that are used frequently for interacting with other systems/tools
- Logging - Explains how logs works and how to add/view them as a developer
- Git Hooks - Notes about workflow enforcements
- Test - files used to run the unit tests (eventually automated tests)
.