{"id":16052403,"url":"https://github.com/devsazal/geo-features-bbox-api","last_synced_at":"2026-04-16T05:03:58.769Z","repository":{"id":190304293,"uuid":"621031587","full_name":"DevSazal/geo-features-bbox-api","owner":"DevSazal","description":"GeoFeatures API  —  to get data as json for any valid coordinates as bounding box (TypeScript, Node.js, Express.js, Docker)","archived":false,"fork":false,"pushed_at":"2023-04-01T23:05:49.000Z","size":9,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-29T04:51:37.562Z","etag":null,"topics":["docker","expressjs","geometry","openstreetmap","typescript","unit-testing"],"latest_commit_sha":null,"homepage":"","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/DevSazal.png","metadata":{"files":{"readme":"README.md","changelog":null,"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}},"created_at":"2023-03-29T21:20:28.000Z","updated_at":"2023-03-31T23:25:34.000Z","dependencies_parsed_at":null,"dependency_job_id":"8fba1427-db10-4dc5-9eff-e35c4f31f57b","html_url":"https://github.com/DevSazal/geo-features-bbox-api","commit_stats":null,"previous_names":["devsazal/geo-features-bbox-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DevSazal%2Fgeo-features-bbox-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DevSazal%2Fgeo-features-bbox-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DevSazal%2Fgeo-features-bbox-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DevSazal%2Fgeo-features-bbox-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DevSazal","download_url":"https://codeload.github.com/DevSazal/geo-features-bbox-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247301419,"owners_count":20916505,"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":["docker","expressjs","geometry","openstreetmap","typescript","unit-testing"],"created_at":"2024-10-09T01:08:51.569Z","updated_at":"2026-04-16T05:03:58.727Z","avatar_url":"https://github.com/DevSazal.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GeoFeatures BoundingBox API\n\n### Requirements:\n\n* Node.js (16.x)\n* NPM\n* TypeScript, Express.js\n* Git\n* Docker - [Install Docker community edition](https://hub.docker.com/search/?type=edition\u0026offering=community) optional.\n\n#### 🎁 If you are a big fan of docker, just don't wait and pull the [docker image](https://hub.docker.com/r/sazal/ts-geofeatures-bbox-backend) by following the commands:\n\n```bash\ndocker pull sazal/ts-geofeatures-bbox-backend:1.0.0.RELEASE\n```\n\n\nLet's clone the repository on your machine.\n\nThe application includes the following files and folders.\n\n- `src` - code for the application written in TypeScript, Express.js.\n- `cli` - node cli script which can be performed from terminal.\n- `__tests__` - to test all the features.\n- `.env.example` - a sample of .env which can be helpful for configuration.\n\n```bash\n# architecture\n# deep drive in src directory\nsrc/\n├── controllers/\n│   └── geo.controller.ts\n├── routes/\n│   └── geo.ts\n├── services/\n│   ├── geo.ts\n│   └── openstreetmap.ts\n├── dto/\n│   └── geo.dto.ts\n├── types/\n│   └── index.ts\n├── lib/\n│   └── helpers.ts\n├── app.ts\n└── index.ts\n\n```\n\n\n## Installation and Configuration\n\nLet's move to the cloned directory with your terminal.\n\nTo install, build, and start the application for the first time, run the following commands in your shell using `makefile` (only for macOS and Linux):\n\n```bash\nmake install\n```\n\nLet's rename from `.env.example` to `.env` and make sure all the necessary information is correct:\n\n```bash\nPORT=3000\n\n```\n\nAlready done? Cool! You are almost ready to enjoy the app. ⛳️\n\n\n### Build:\n```\nmake build\n```\n\n### Run:\n```bash\nmake start\n```\n\n### API Endpoint:\n\n```bash\nGET /geo/features?bbox=6.883,51.4243,6.8933,51.4326\n# try the api with postman\n# port 3000\n```\n#### A Sample URL:\n- `http://localhost:3000/geo/features?bbox=6.883,51.4243,6.8933,51.4326`\n\n### Test:\nOh! You wanna trigger unit testing for the application from terminal\n\u003cbr\u003e\n```bash\nmake test\nmake test-unit\n```\n\n\n### lint:\n```\nmake lint\n```\n### lintfix:\n```\nmake lintfix\n```\n\n#### 🎯 I know, you liked it.\nTo learn more, you can use the following commands: \n```\nmake help\n```\n\n#### At the same time, you can use the default `npm` commands like:\n```bash\nnpm i\nnpm run build\nnpm run start\nnpm run test\n```\n\n#### 🥇 Congrats!! You are good to go\n\n#### 🧑‍💻 Stay in touch\n\n- Author - [Sazal Ahamed](https://sazal.vercel.app)\n\n#### tada! 🎉\n\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevsazal%2Fgeo-features-bbox-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevsazal%2Fgeo-features-bbox-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevsazal%2Fgeo-features-bbox-api/lists"}