{"id":15718436,"url":"https://github.com/justintime50/dad-node","last_synced_at":"2025-04-30T14:40:18.512Z","repository":{"id":42719952,"uuid":"251416986","full_name":"Justintime50/dad-node","owner":"Justintime50","description":"Dummy Address Data (DAD) - Retrieve real addresses from all around the world. (Node Client Library)","archived":false,"fork":false,"pushed_at":"2025-01-07T21:32:33.000Z","size":669,"stargazers_count":11,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-24T03:38:37.905Z","etag":null,"topics":["address","addresses","dad","data","dataset","dummy","dummy-data","real","retrieving-addresses","world"],"latest_commit_sha":null,"homepage":"https://github.com/justintime50/dad","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Justintime50.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["Justintime50"]}},"created_at":"2020-03-30T20:10:08.000Z","updated_at":"2025-02-13T03:36:57.000Z","dependencies_parsed_at":"2023-02-13T01:45:14.648Z","dependency_job_id":"97c9137e-3779-46cd-8d2d-23740ada0502","html_url":"https://github.com/Justintime50/dad-node","commit_stats":{"total_commits":53,"total_committers":3,"mean_commits":"17.666666666666668","dds":0.4716981132075472,"last_synced_commit":"245bd98d63ed0abcf9cd4b257eb7f517905588b5"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Justintime50%2Fdad-node","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Justintime50%2Fdad-node/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Justintime50%2Fdad-node/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Justintime50%2Fdad-node/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Justintime50","download_url":"https://codeload.github.com/Justintime50/dad-node/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251722713,"owners_count":21632999,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["address","addresses","dad","data","dataset","dummy","dummy-data","real","retrieving-addresses","world"],"created_at":"2024-10-03T21:53:03.786Z","updated_at":"2025-04-30T14:40:18.459Z","avatar_url":"https://github.com/Justintime50.png","language":"JavaScript","funding_links":["https://github.com/sponsors/Justintime50"],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n# Dummy Address Data (DAD) Node Library\n\nDummy Address Data (DAD) - Retrieve real addresses from all around the world.\n\n[![Build Status](https://github.com/Justintime50/dad-node/workflows/build/badge.svg)](https://github.com/Justintime50/dad-node/actions)\n[![Coverage Status](https://coveralls.io/repos/github/Justintime50/dad-node/badge.svg?branch=main)](https://coveralls.io/github/Justintime50/dad-node?branch=main)\n[![NPM](https://img.shields.io/npm/v/dad-tool)](https://www.npmjs.com/package/dad-tool)\n[![Licence](https://img.shields.io/github/license/justintime50/dad-node)](https://opensource.org/licenses/mit-license.php)\n\n\u003cimg src=\"https://raw.githubusercontent.com/justintime50/assets/main/src/dad/showcase.png\" alt=\"Showcase\"\u003e\n\n\u003c/div\u003e\n\nThe DAD Node library is the perfect companion to quickly bootstrap address data in your application. DAD provides real addresses from all over the world with a consistent data structure so you can spend less time looking up addresses and address rules and more time coding. Rigorously tested with 2000+ tests, rest easy knowing your address data is uniform, accurate, and performant.\n\n## Install\n\n```bash\n# Install globally for CLI implementation\nnpm i -g dad-tool\n\n# Install locally for package implementation\nnpm i dad-tool\n```\n\n## Address Data\n\nAddress objects will look like the [sample below](#sample-address-object). The data type of each field on an address object is a `string`. A list of addresses is an `array` of `json` objects.\n\nAttempts have been made to verify addresses and ensure that street1, city, state, and zip are present on all records. Some lists may be shorter than others to avoid complexity or because of a lack of accurate data.\n\nThe following files can be found in the `data` directory.\n\n## Australia\n\n| Locations     | Tag   |\n| ------------- | ----- |\n| Victoria Area | AU_VT |\n\n## Canada\n\n| Locations | Tag   |\n| --------- | ----- |\n| BC Area   | CA_BC |\n\n## China\n\n| Locations                 | Tag   |\n| ------------------------- | ----- |\n| Beijing Area              | CN_BJ |\n| Hong Kong - Wan Chai Area | CN_HK |\n\n## Europe\n\n| Locations                     | Tag   |\n| ----------------------------- | ----- |\n| Germany - Wesel Area          | EU_DE |\n| Spain - Countrywide           | EU_ES |\n| France - Paris Area           | EU_FR |\n| United Kingdom - England Area | EU_UK |\n\n## Mexico\n\n| Locations                 | Tag   |\n| ------------------------- | ----- |\n| Mexico - Mexico City Area | MX_MX |\n\n## United States\n\n| Locations                 | Tag   |\n| ------------------------- | ----- |\n| Arizona - Gilbert Area    | US_AZ |\n| California - Anaheim Area | US_CA |\n| Idaho - Boise Area        | US_ID |\n| Kansas - Barton County    | US_KS |\n| Nevada - Lincoln Area     | US_NV |\n| New York - Rochester Area | US_NY |\n| Oregon - Portland Area    | US_OR |\n| Texas - Austin Area       | US_TX |\n| Utah - Provo Area         | US_UT |\n| Washington - Spokane Area | US_WA |\n\n## Usage\n\n### CLI Implementation\n\n```bash\n# Returns a random address from a list to console\ndad US_UT\n```\n\n### Package Implementation\n\n```javascript\nconst dad = require('dad-tool');\n\n// Grab a random UT address\nconst address = dad.random('US_UT');\nconsole.log(address);\n\n// Alternatively, grab the entire UT list\nconst addresses = dad.list('US_UT');\nconsole.log(addresses);\n\n// Print to console or do whatever you'd like with the address data\nconsole.log(address.city);\n\n// Get the list of all ISO country codes\nconst isoData = dad.isoCountryCodes();\nfor (let i = 0; i \u003c isoData.length; i++) {\n  console.log(JSON.stringify(isoData[i], null, 4));\n}\n```\n\n### Sample Address Object\n\nA sample address object will look like the following:\n\n```json\n{\n  \"street1\": \"231 N 1200 W\",\n  \"street2\": \"UNIT 104\",\n  \"city\": \"OREM\",\n  \"state\": \"UT\",\n  \"zip\": \"84057\",\n  \"country\": \"US\"\n}\n```\n\n### Sample ISO Country Object\n\n```json\n{\n  \"country\": \"United States of America\",\n  \"alpha_2_code\": \"US\",\n  \"alpha_3_code\": \"USA\"\n}\n```\n\n## Development\n\n```bash\n# Lint the project\nnpm run lint\n\n# Run tests\nnpm run test\n\n# Run test coverage\nnpm run coverage\n\n# Update the DAD data files\ngit submodule init \u0026\u0026 git submodule update --remote dad\n```\n\n## Attribution\n\n- Addresses provided by [DAD](https://github.com/justintime50/dad).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjustintime50%2Fdad-node","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjustintime50%2Fdad-node","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjustintime50%2Fdad-node/lists"}