{"id":21129181,"url":"https://github.com/3n3a-archive/plz-api","last_synced_at":"2025-07-09T00:31:52.511Z","repository":{"id":177381240,"uuid":"656395370","full_name":"3n3a-archive/plz-api","owner":"3n3a-archive","description":null,"archived":true,"fork":false,"pushed_at":"2023-07-02T12:00:12.000Z","size":87,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-11-20T05:17:46.805Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","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/3n3a-archive.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":"2023-06-20T21:44:59.000Z","updated_at":"2024-06-30T20:35:10.000Z","dependencies_parsed_at":null,"dependency_job_id":"a3648e99-c8e7-47f1-a99f-30f6e0a69f01","html_url":"https://github.com/3n3a-archive/plz-api","commit_stats":null,"previous_names":["3n3a/plz-api","3n3a-archive/plz-api"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3n3a-archive%2Fplz-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3n3a-archive%2Fplz-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3n3a-archive%2Fplz-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3n3a-archive%2Fplz-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/3n3a-archive","download_url":"https://codeload.github.com/3n3a-archive/plz-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225471274,"owners_count":17479449,"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":[],"created_at":"2024-11-20T05:18:07.802Z","updated_at":"2024-11-20T05:18:08.842Z","avatar_url":"https://github.com/3n3a-archive.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Postal Code API\n\n\u003e An API that allows searching in Switzerlands Postal Codes\n\n## Features\n\n* Caches Responses for 30 Minutes\n* Compresses Responses with GZIP\n* Fast JSON-Encoding\n\n## Env Vars\n\n* `DB_CONN`\n* `CACHE_DURATION` - in Minutes\n\n## Run Locally\n\n```bash\nair\n```\n\n## Generate Documentation (Swagger)\n\nRun this command\n\n```bash\nswag init\n```\n\n### Problems in ASDF\n\nRUn this first\n\n```bash\nasdf reshim\n```\n\n## Build Docker Image Locally\n\n```bash\ndocker build -t plz-api .\n```\n\n### Run the Image\n\nDatabase needs to be running!\n\n```bash\ndocker run --rm -p 3000:3000 --name plz_api -e DB_CONN=\"\u003cDB_CONN\u003e\" plz-api\n```\n\n## Todo\n\n- [x] Consider upping the time data stays in cache, because source only updates every month... Maybe to 1 Month?\n- [ ] ...","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F3n3a-archive%2Fplz-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F3n3a-archive%2Fplz-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F3n3a-archive%2Fplz-api/lists"}