{"id":28391978,"url":"https://github.com/beuluis/speedtest-api","last_synced_at":"2026-05-04T01:34:45.002Z","repository":{"id":55592371,"uuid":"310271112","full_name":"beuluis/speedtest-api","owner":"beuluis","description":"Collects Speedtest values and makes them available via REST","archived":false,"fork":false,"pushed_at":"2024-08-14T02:57:31.000Z","size":105,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"develop","last_synced_at":"2025-06-25T10:49:44.104Z","etag":null,"topics":["docker","docker-compose","nodejs","rest-api","restify","speedtest"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/beuluis.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":"2020-11-05T10:59:19.000Z","updated_at":"2020-12-23T20:47:10.000Z","dependencies_parsed_at":"2024-08-12T04:02:47.849Z","dependency_job_id":null,"html_url":"https://github.com/beuluis/speedtest-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/beuluis/speedtest-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beuluis%2Fspeedtest-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beuluis%2Fspeedtest-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beuluis%2Fspeedtest-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beuluis%2Fspeedtest-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/beuluis","download_url":"https://codeload.github.com/beuluis/speedtest-api/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beuluis%2Fspeedtest-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32591601,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-03T22:12:39.696Z","status":"ssl_error","status_checked_at":"2026-05-03T22:09:10.534Z","response_time":103,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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","docker-compose","nodejs","rest-api","restify","speedtest"],"created_at":"2025-05-31T10:39:20.459Z","updated_at":"2026-05-04T01:34:44.997Z","avatar_url":"https://github.com/beuluis.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Contributors][contributors-shield]][contributors-url]\n[![Forks][forks-shield]][forks-url]\n[![Stargazers][stars-shield]][stars-url]\n[![Issues][issues-shield]][issues-url]\n\n\u003e :warning: speedtest-net does not support newer node versions. Please use node 12\n\n\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://www.flaticon.com/svg/static/icons/svg/248/248053.svg\" alt=\"Logo\" height=\"60\"\u003e\n\n  \u003ch3 align=\"center\"\u003espeedtester-api\u003c/h3\u003e\n\n  \u003cp align=\"center\"\u003e\n    Collects Speedtest values and makes them available via REST\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    ·\n    \u003ca href=\"https://github.com/beuluis/speedtest-api/issues\"\u003eReport Bug\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/beuluis/speedtest-api/issues\"\u003eRequest Feature\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/p\u003e\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n## About The Project\n\nSmall docker setup for collecting Speedtest values and makes them available via REST. Utilizes [speedtest-net](https://www.npmjs.com/package/speedtest-net) and [restify](https://www.npmjs.com/package/restify).\n\n\u003c!-- GETTING STARTED --\u003e\n## Getting Started Develop\n\nTo get a local copy up and running follow these simple steps.\n\n### Prerequisites\n\n* [Docker](https://docs.docker.com/get-docker/)\n* [Docker Compose](https://docs.docker.com/compose/install/)\n\n### Installation\n\n1. Clone the repo\n```sh\ngit clone https://github.com/beuluis/speedtest-api.git --branch develop\n```\n2. Start docker-compose\n```sh\ndocker-compose up --build\n```\n3. Call the api with `localhost:{your port}` as base url\n\n### Customization\n\n1. Create a `.env` file\n```sh\ntouch .env\n```\n2. Overwrite variables as you like (format: `{variable name}={variable value}`)\n\n| Variable | Description | Default value | Required |\n| --- | --- | --- | --- |\n| `INSPECT_PORT` | Node inspect port | 9229 | false |\n| `PORT` | Which port is mapped to your host machine | 3300 | false |\n| `PG_DB` | Postgres DB name | speedtestApiDev | false |\n| `PG_USER` | Postgres user | speedtestApiDev | false |\n| `PG_PASSWORD` | Postgres password | sahjbbd74bds74 | false |\n\n## Getting Started Staging\n\nTo get a copy up and running follow these simple steps.\n\n### Prerequisites\n\n* [Docker](https://docs.docker.com/get-docker/)\n* [Docker Compose](https://docs.docker.com/compose/install/)\n\n### Installation\n\n1. Clone the repo\n```sh\ngit clone https://github.com/beuluis/speedtest-api.git --branch master --bare\n```\n2. Create a `.env.stg` file\n```sh\ntouch .env.stg\n```\n3. Overwrite all variables marked under Customization as required\n4. Overwrite config variables. See Customize application\n5. Start docker-compose\n```sh\ndocker-compose --env-file ./.env.stg -f docker-compose.yml -f docker-compose.staging.yml up -d\n```\n\n### Customization\n\n1. Create a `.env.stg` file\n```sh\ntouch .env.stg\n```\n2. Overwrite variables as you like (format: `{variable name}={variable value}`)\n\n| Variable | Description | Default value | Required |\n| --- | --- | --- | --- |\n| `PG_DB` | Postgres DB name | speedtestApiStg | false |\n| `PG_USER` | Postgres user | speedtestApiStg | false |\n| `PG_PASSWORD` | Postgres password | none | true |\n\n## Getting Started Production\n\nTo get a copy up and running follow these simple steps.\n\n### Prerequisites\n\n* [Docker](https://docs.docker.com/get-docker/)\n* [Docker Compose](https://docs.docker.com/compose/install/)\n\n### Installation\n\n1. Clone the repo\n```sh\ngit clone https://github.com/beuluis/speedtest-api.git --branch master\n```\n2. Create a `.env.prod` file\n```sh\ntouch .env.prod\n```\n3. Overwrite all variables marked under Customization as required\n4. Overwrite config variables. See Customize application\n5. Start docker-compose\n```sh\ndocker-compose --env-file ./.env.prod -f docker-compose.yml -f docker-compose.production.yml up -d\n```\n\n### Customization\n\n1. Create a `.env.prod` file\n```sh\ntouch .env.prod\n```\n2. Overwrite variables as you like (format: `{variable name}={variable value}`)\n\n| Variable | Description | Default value | Required |\n| --- | --- | --- | --- |\n| `PG_DB` | Postgres DB name | speedtestApiProd | false |\n| `PG_USER` | Postgres user | speedtestApiProd | false |\n| `PG_PASSWORD` | Postgres password | none | true |\n\n## Endpoint dokumentation\n\nThe endpoints are documented in swagger. You can navigate to swagger on your local instance, like `localhost:{your port}/swagger` or got to [swagger dokumentation](https://beuluis.github.io/speedtest-api/).\n\n### Customize application\n\nI use [config](https://www.npmjs.com/package/config). Pleas look at their dokumentation\n\n\u003c!-- CONTRIBUTING --\u003e\n## Contributing\n\nContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n\n\u003c!-- CONTACT --\u003e\n## Contact\n\nLuis Beu - me@luisbeu.de\n\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n\u003c!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --\u003e\n[contributors-shield]: https://img.shields.io/github/contributors/beuluis/speedtest-api.svg?style=flat-square\n[contributors-url]: https://github.com/beuluis/speedtest-api/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/beuluis/speedtest-api.svg?style=flat-square\n[forks-url]: https://github.com/beuluis/speedtest-api/network/members\n[stars-shield]: https://img.shields.io/github/stars/beuluis/speedtest-api.svg?style=flat-square\n[stars-url]: https://github.com/beuluis/speedtest-api/stargazers\n[issues-shield]: https://img.shields.io/github/issues/beuluis/speedtest-api.svg?style=flat-square\n[issues-url]: https://github.com/beuluis/speedtest-api/issues\n[license-shield]: https://img.shields.io/github/license/beuluis/speedtest-api.svg?style=flat-square\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeuluis%2Fspeedtest-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbeuluis%2Fspeedtest-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeuluis%2Fspeedtest-api/lists"}