Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/openpotato/openholidaysapi
Web service for the OpenHolidays API project
https://github.com/openpotato/openholidaysapi
open-data openholidaysapi
Last synced: 2 months ago
JSON representation
Web service for the OpenHolidays API project
- Host: GitHub
- URL: https://github.com/openpotato/openholidaysapi
- Owner: openpotato
- License: agpl-3.0
- Created: 2022-07-01T16:15:38.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-12T18:05:15.000Z (about 1 year ago)
- Last Synced: 2023-12-12T19:36:03.065Z (about 1 year ago)
- Topics: open-data, openholidaysapi
- Language: C#
- Homepage: https://openholidaysapi.org/swagger/index.html
- Size: 157 KB
- Stars: 7
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OpenHolidays API
The service behind the OpenHolidays API. Build with [.NET 8](https://dotnet.microsoft.com/).
## Technology stack
+ [PostgreSQL 17](https://www.postgresql.org/) as database
+ [ASP.NET 8](https://dotnet.microsoft.com/apps/aspnet) as web framework
+ [Entity Framework Core 8](https://docs.microsoft.com/ef/) as ORM layer
+ [Swagger UI](https://swagger.io/tools/swagger-ui/) for OpenAPI based documentation
## Getting started
The following instructions show you how to set up a development environment on your computer.
### Prerequisites
+ Set up a local PosgreSQL 17 (or higher) instance.
+ Clone or download the repository [OpenHolidaysApi.Data](https://github.com/openpotato/openholidaysapi.data).
+ Clone or download this repository.
+ Open the solution file `OpenHolidaysApi.sln` in Visual Studio 2022.
### Configure the OpenHolidaysApi CLI
+ Switch to the project `OpenHolidaysApi.CLI`.
+ Make a copy of the the `appsettings.json` file and name it `appsettings.Development.json`.
+ Exchange the content with the following JSON document and adjust the values to your needs. This configures the root folder for the csv data sources (the `src` folder in your local [OpenHolidaysApi.Data](https://github.com/openpotato/openholidaysapi.data) repository) and the database connection.
``` json
"Sources": {
"RootFolderName": "c:\\openholidaysapi.data\\src"
},
"Database": {
"Server": "localhost",
"Database": "OpenHolidaysApi",
"Username": "postgres",
"Password": "qwertz"
}
```
### Create and populate the database
+ Build the `OpenHolidaysApi.CLI` project.
+ Run the `OpenHolidaysApi.CLI` project with parameter `initdb --import`. This will create and populate the PostgreSQL database.
### Configure the OpenHolidaysApi WebService
+ Switch to the `OpenHolidaysApi.WebService`.
+ Make a copy of the the `appsettings.json` file and name it `appsettings.Development.json`.
+ Exchange the content with the following JSON document and adjust the values to your needs. This configures the database connection.
``` json
"Database": {
"Server": "localhost",
"Database": "OpenHolidaysApi",
"Username": "postgres",
"Password": "qwertz"
}
```
### Build and test the API
+ Build the `OpenHolidaysApi.WebService` project.
+ Run the `OpenHolidaysApi.WebService` project and play with the Swagger UI.
## Can I help?
Yes, 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.