{"id":22477414,"url":"https://github.com/ilmarin/points","last_synced_at":"2025-03-27T17:45:16.336Z","repository":{"id":42647970,"uuid":"183008303","full_name":"ilmarin/points","owner":"ilmarin","description":"Simple API based on Lumen framework","archived":false,"fork":false,"pushed_at":"2023-04-19T19:10:26.000Z","size":112,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-01T21:11:12.496Z","etag":null,"topics":["laravel-lumen","lumen","lumen-framework","lumen-php-framework","php","rest-api"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ilmarin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2019-04-23T12:17:46.000Z","updated_at":"2019-07-04T19:05:25.000Z","dependencies_parsed_at":"2025-02-01T21:10:56.834Z","dependency_job_id":"9a1ba2c1-ea31-4cec-9144-0295e6edb871","html_url":"https://github.com/ilmarin/points","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ilmarin%2Fpoints","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ilmarin%2Fpoints/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ilmarin%2Fpoints/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ilmarin%2Fpoints/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ilmarin","download_url":"https://codeload.github.com/ilmarin/points/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245897782,"owners_count":20690455,"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":["laravel-lumen","lumen","lumen-framework","lumen-php-framework","php","rest-api"],"created_at":"2024-12-06T14:10:47.059Z","updated_at":"2025-03-27T17:45:16.291Z","avatar_url":"https://github.com/ilmarin.png","language":"PHP","readme":"# Points API\n\nSimple example of API that allows to store some interesting places with their map coordinates and description.\n\nWith this API you can:\n\n* Add Point info (name, description, coordinates, city)\n* Edit Point info\n* Get nearest Points by desired radius and IP address\n* Get Points located in desired city\n\n## Installation\n\n1. In project folder execute `docker-compose up -d`\n2. Enter container with `docker exec -ti points bash`\n3. Execute `composer install`\n4. Rename `.env.example` file into `.env`\n5. Execute `./artisan migrate --force` to run database migrations\n6. In `.env` file write your `IP_STACK_KEY` and `API_TOKEN`\n7. Check api status by address `http://localhost:8080/api/v1/health?api_token=123`\n\n## Tests \n\nTo run unit tests execute `vendor/bin/phpunit tests/unit` inside `points` container.\n\nTo run only functional tests execute `vendor/bin/phpunit tests/functional`.\n\nTo run all tests execute `vendor/bin/phpunit`.\n\n## Working with API\n\n### Token auth\n\nAll requests must contain `api_token` parameter with `API_TOKEN` environment variable value.\n\nExample: `GET /api/v1/health?api_token=123`\n\n### Health check\n\nGet health status of the service.\n\nURL: `GET /api/v1/health`\n\n[Description](docs/health.md) \n\n### Point related requests\n\nEndpoints for viewing and manipulating points.\n\n* [Add Point](docs/points/add.md): `POST /api/v1/points`\n* [Update Point](docs/points/update.md): `PUT /api/v1/points/:pk`\n* [Show points by desired ip and radius](docs/points/inrad.md): `GET /api/v1/points/inrad`\n* [Show points in desired city](docs/points/in.md): `GET /api/v1/points/in/:city`","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Filmarin%2Fpoints","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Filmarin%2Fpoints","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Filmarin%2Fpoints/lists"}