Skip to content

Latest commit

 

History

History
14 lines (9 loc) · 849 Bytes

CONTRIBUTING.md

File metadata and controls

14 lines (9 loc) · 849 Bytes
Raw

Contributing

Contributions are welcome! Please follow the standard Github Fork & Pull Request Workflow.

All contributions are considered to use the Unlicense license.

To add a new geolocation provider

If it requires server-side fetching of data (most providers do, to prevent abuse):

  1. src/config.ts: add a setting for the credentials
  2. src/action/xxxxxlookup.ts: the code that fetches the data. Use one of the existing providers as a template to keep the return value, logging and error handling consistent.
  3. src/routers/ipRouter.ts: add an import and a router mapping.
  4. views/ip/geolocation.hbs: add a row in the HTML <table> and a call to the remote API (at the very bottom of the file, like the others).