{"id":16694083,"url":"https://github.com/haoliangyu/ogcapi-js","last_synced_at":"2025-05-07T21:41:37.980Z","repository":{"id":38418519,"uuid":"243341814","full_name":"haoliangyu/ogcapi-js","owner":"haoliangyu","description":"A lightweight and modular JavaScript/TypeScript library for OGC APIs","archived":false,"fork":false,"pushed_at":"2025-03-13T02:56:24.000Z","size":9750,"stargazers_count":26,"open_issues_count":4,"forks_count":5,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-25T15:03:54.701Z","etag":null,"topics":["client-library","features","javascript","ogc-apis","ogcapi","ogcapi-js","typescript"],"latest_commit_sha":null,"homepage":"https://haoliangyu.github.io/ogcapi-js","language":"TypeScript","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/haoliangyu.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}},"created_at":"2020-02-26T18:58:47.000Z","updated_at":"2025-03-13T02:56:26.000Z","dependencies_parsed_at":"2023-02-17T21:16:02.321Z","dependency_job_id":"5874ae16-b034-4d6c-b2bf-6c0ee33bfd6e","html_url":"https://github.com/haoliangyu/ogcapi-js","commit_stats":{"total_commits":145,"total_committers":7,"mean_commits":"20.714285714285715","dds":"0.45517241379310347","last_synced_commit":"e727644a5fecc2f6db6c06022873b55ad6d8d84e"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haoliangyu%2Fogcapi-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haoliangyu%2Fogcapi-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haoliangyu%2Fogcapi-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haoliangyu%2Fogcapi-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/haoliangyu","download_url":"https://codeload.github.com/haoliangyu/ogcapi-js/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252690899,"owners_count":21789248,"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":["client-library","features","javascript","ogc-apis","ogcapi","ogcapi-js","typescript"],"created_at":"2024-10-12T16:43:42.824Z","updated_at":"2025-05-07T21:41:37.945Z","avatar_url":"https://github.com/haoliangyu.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ogcapi-js\n\nA lightweight and modular JavaScript library for [OGC APIs](https://ogcapi.ogc.org/) that implements:\n\n* [@ogcapi-js/features](./packages/features)\n* [@ogcapi-js/processes](./packages/processes)\n\nCompared to writing the request code yourself, this library provides:\n\n* More developer-friendly APIs\n* Better request error handling\n* Query parameter validation\n* TypeScript support\n\nSee more details at the [documentation](https://haoliangyu.github.io/ogcapi-js).\n\nThis library is designed to work in both Node.js and browser environments.\n\n## Testing\n\nThe stability of this library is ensured by an extensive collection of unit and E2E tests. The following sections describes how to run those tests locally.\n\n### Unit tests\n\nTo run unit tests, execute the following command:\n\n```bash\nnpm run test\n```\n\n### E2E tests\n\nThe E2E tests of this library are executed against a specially crafted OGC API instance with pre defined sample datasets based on [pygeoapi](https://pygeoapi.io/), which is provided as a Docker image.\n\n\u003e Note: Further information about the Docker image can be found in the corresponding [Dockerfile](./docker/e2e/Dockerfile).\n\nTo run E2E tests locally, first run the following command from the root directory of this repository to start the E2E OGC API test instance:\n\n```bash\ndocker run --rm -it -p 5000:80 \\\n          --pull=always \\\n          --health-cmd \"curl http://localhost\" \\\n          --health-interval 10s \\\n          --health-timeout 5s \\\n          --health-retries 5 \\\n          ghcr.io/haoliangyu/ogcapi-js:master\n```\n\nAfter that, run in separate shell the following command to execute E2E tests.\n\n```bash\n$ npm run test:e2e\n```\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhaoliangyu%2Fogcapi-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhaoliangyu%2Fogcapi-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhaoliangyu%2Fogcapi-js/lists"}