{"id":20238795,"url":"https://github.com/openpotato/openplzapi","last_synced_at":"2025-09-22T06:32:04.588Z","repository":{"id":171767017,"uuid":"576275231","full_name":"openpotato/openplzapi","owner":"openpotato","description":"Web service for the OpenPLZ API project","archived":false,"fork":false,"pushed_at":"2024-12-16T12:12:59.000Z","size":408,"stargazers_count":8,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"develop","last_synced_at":"2024-12-16T13:23:39.253Z","etag":null,"topics":["gemeindeverzeichnis","open-data","openplzapi","postleitzahlen","strassenverzeichnis"],"latest_commit_sha":null,"homepage":"https://openplzapi.org/swagger/index.html","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openpotato.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,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-12-09T12:40:14.000Z","updated_at":"2024-12-16T12:13:04.000Z","dependencies_parsed_at":null,"dependency_job_id":"13281054-0eaa-4604-973b-24f459409a41","html_url":"https://github.com/openpotato/openplzapi","commit_stats":null,"previous_names":["openpotato/openplzapi"],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openpotato%2Fopenplzapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openpotato%2Fopenplzapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openpotato%2Fopenplzapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openpotato%2Fopenplzapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openpotato","download_url":"https://codeload.github.com/openpotato/openplzapi/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":233828202,"owners_count":18736584,"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":["gemeindeverzeichnis","open-data","openplzapi","postleitzahlen","strassenverzeichnis"],"created_at":"2024-11-14T08:35:45.781Z","updated_at":"2025-09-22T06:31:59.225Z","avatar_url":"https://github.com/openpotato.png","language":"C#","readme":"![GitHub](https://img.shields.io/github/license/openpotato/openplzapi)\n\n# OpenPLZ API\n\nThe service behind OpenPLZ API. Build with [.NET 9](https://dotnet.microsoft.com/).\n\n## Technology stack\n\n+ [PostgreSQL 17](https://www.postgresql.org/) as database\n+ [ASP.NET 9](https://dotnet.microsoft.com/apps/aspnet) as web framework\n+ [Entity Framework Core 9](https://docs.microsoft.com/ef/) as ORM layer\n+ [Swagger UI](https://swagger.io/tools/swagger-ui/) for OpenAPI based documentation\n\n## Getting started \n\nThe following instructions show you how to set up a development environment on your computer.\n\n### Prerequisites\n\n+ Set up a local PosgreSQL 17 (or higher) instance.\n+ Clone or download this repository.\n+ Open the solution file `OpenPlzApi.sln` in Visual Studio 2022.\n\n### Configure the OpenPLZ API CLI\n\n+ Switch to the project `OpenPlzApi.CLI`.\n+ Make a copy of the the `appsettings.json` file and name it `appsettings.Development.json`.\n+ Exchange the content with the following JSON document and adjust the values to your needs. This configures the root folder for the data file downloads and the database connection.\n  \n  ``` json\n  \"Sources\": {\n    \"RootFolderName\": \"c:\\\\OpenPlzApi.Downloads\"\n  },\n  \"Database\": {\n    \"Server\": \"localhost\",\n    \"Database\": \"OpenPlzApi\",\n    \"Username\": \"postgres\",\n    \"Password\": \"qwertz\"\n  }\n  ```\n\n### Create and populate the database\n\n+ Build the `OpenPlzApi.CLI` project. \n+ Run the `OpenPlzApi.CLI` project with parameter `initdb --import`. This will create and populate the PostgreSQL database.\n\n### Configure the OpenPLZ API WebService\n\n+ Switch to the  `OpenPlzApi.WebService`. \n+ Make a copy of the the `appsettings.json` file and name it `appsettings.Development.json`.\n+ Exchange the content with the following JSON document and adjust the values to your needs. This configures the database connection.\n\n  ``` json\n  \"Database\": {\n    \"Server\": \"localhost\",\n    \"Database\": \"OpenPlzApi\",\n    \"Username\": \"postgres\",\n    \"Password\": \"qwertz\"\n  }\n  ```\n\n### Build and test the API\n\n+ Build the `OpenPlzApi.WebService` project.\n+ Run the `OpenPlzApi.WebService` project and play with the Swagger UI.\n\n## Can I help?\n\nYes, that would be much appreciated. The best way to help is to post a response via the Issue Tracker and/or submit a Pull Request.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenpotato%2Fopenplzapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenpotato%2Fopenplzapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenpotato%2Fopenplzapi/lists"}