Źródła powstającego powoli serwisu z bazą danych wydarzeń historycznych z XVI wieku. Serwis w wersji beta powinien być widoczny pod tym adresem: xvi-wiek.pl.
Serwis wykorzystuje styl Tufte CSS (licencja MIT ) z dodatkiem fontu Crimson Pro (licencja Open Font License) Regular 400 i Regular 400 italic.
Backend serwisu obsługiwany jest przez program w języku Go, pliki yaml i mechanizm pamięci podręcznej typu klucz-wartość (go-cache, licencja MIT). W roli routera wykorzystywany jest chi. Walidacja danych - pakiet validator.
Ikona Github pochodzi ze strony GitHub Logos and Usage.
Ikona Twitter pochodzi ze strony Twitter Brand Resources.
Dodatkowy mechanizm to bot wysyłający raz dziennie na twitterowe konto @xvi-wiek informację o ciekawym wydarzeniu historycznym, które zdarzyło się w XVI wieku właśnie w tym dniu. Kod źródłowy bota dostępny jest w osobnym repozytorium: xvi-wiek-bot.
Treść serwisu jest także dostępna w formie ebooka (format pdf). Automatyczną konwersję z plików yaml do formatu LaTeX wykonuje program yaml2latex, którego kod źródłowy dostępny jest w osobnym repozytorium xvi-wiek-yaml2latex.
Ten serwis zapewne nie powstałby, przynajmniej nie w takiej formie i nie w języku Go, gdyby nie lektura książki Alexa Edwardsa "Let's Go! Learn to Build Professional Web Applications With Golang".
Description in English:
Sources of a slowly emerging "XVI wiek" (16th century) service with a database of historical events from the 16th century (mainly about the Kingdom of Poland and Prussia and neighbouring states). The beta version of the service should be visible at this address: xvi-wiek.pl.
App uses the Tufte CSS style (MIT license) with the addition of the Crimson Pro font (Open Font License) Regular 400 and Regular 400 italic.
The backend is supported by a Go program, yaml files and a key-value cache mechanism (go-cache, MIT license). Chi is used as a router. Data validation - validator package.
The Github icon is from the GitHub Logos and Usage page.
The Twitter icon comes from the Twitter Brand Resources page.
An additional mechanism is a bot that sends information once a day to the @xvi-century twitter account about an interesting historical event that happened in the 16th century on that day. The bot source code is available in a separate repository: xvi-wiek-bot.
The content of the service is also available as an ebook (pdf). Automatic conversion from yaml files to LaTeX format is done by the yaml2latex program, whose source code is available in a separate repository: xvi-wiek-yaml2latex.
This service probably would not have been created, at least not in this form and not in the Go language, if I hadn't read the Alex Edwards' book "Let's Go! Learn to Build Professional Web Applications With Golang".
go test -cover ./cmd/web
coverage: 68.1% of statements
GET /api/day/{month}/{day}
Zwraca wydarzenia z określonego dnia np. /api/day/4/10 zwróci
wydarzenia z 10 kwietnia.
GET /api/today
Zwraca dzisiejsze wydarzenia, zapytanie uruchomione 1 stycznia 2020
zwróci wydarzenia z 1 stycznia.
Domyślnie zapytania zwracają wynik w formacie json, ale można także otrzymać
wynik w formacie xml ustawiając Content-Type na 'application/xml' w nagłówku
zapytania http.
GET /api/healthcheck
Zwraca informacje o statusie api (zwykle: "dostępny") i wersji (obecnie: "1.0.0")
GET /api/fact/6/10/1
Zwraca wydarzenie historyczne z 10 czerwca o id = 1 (może istnieć kilka wydarzeń
w tym samym dniu)
GET /api/find?searchQuery=Firlej
Zwraca wynik wyszukiwania dla słowa np. Firlej w postaci listy wydarzeń
historycznych w których wystąpiło szukane słowo. Zwracana lista wydarzeń
zawiera tylko podstawowe informacje: data, dzień, miesiąc, tytuł, skrót
treści i id wydarzenia, następnie zapytaniem /api/fact np. GET /api/fact/6/10/1
można pobrać pełną treść wydarzenia
GET /api/find?searchQuery=Jan%20Kostka
Podobnie, zwraca wynik wyszukiwania dla postaci "Jan Kostka"
Liczba zapytań API jest obecnie ograniczona (z uwzględnieniem IP klienta) do około 10 na sekundę.
Przykład odpowiedzi na zapytanie curl https://xvi-wiek.pl/api/today:
[
{
"date":"07-01-1520",
"title":"Król Zygmunt I Stary wydał przywilej toruński",
"content":"7 stycznia 1520 roku król Zygmunt I Stary wydał przywilej toruński regulujący minimalny wymiar pańszczyzny (1 dzień w tygodniu od łana). Rzeczywisty wymiar pańszczyzny często był już wówczas większy. Dodatkowo przywilej ten regulował prawo do wolnej żeglugi po Wiśle, ograniczając je tylko do szlachty, ograniczono także prawa miast do sprawowania sądów nad szlachcicami, którzy popełnili przestępstwa na terenie miast. Moment wydania przywileju przypada na okres przygotowań do wojny z zakonem krzyżackim, król potrzebował zgody szlachty na zwiększenie podatków, w zamian szlachta oczekiwała i otrzymała przywileje, często kosztem innych stanów.",
"location":"Toruń",
"geo":"52.2476,21.0138",
"people":"Zygmunt I Stary",
"keywords":"przywilej",
"sources":[
{
"value":"Wikipedia",
"url":"https://pl.wikipedia.org/wiki/Przywilej_toru%C5%84ski_1520"
},
{
"value":"Przegląd Historyczny, 1913",
"url":"http://bazhum.muzhp.pl/media//files/Przeglad_Historyczny/Przeglad_Historyczny-r1913-t16-n2/Przeglad_Historyczny-r1913-t16-n2-s200-217/Przeglad_Historyczny-r1913-t16-n2-s200-217.pdf"
}
]
}
]Przykład odpowiedzi na zapytanie curl --header "Content-Type: application/xml" https://xvi-wiek.pl/api/today:
<HistoricalEvent>
<date>18-03-1584</date>
<title>Zmarł Iwan IV Groźny</title>
<content>18 marca 1584 roku w Moskwie podczas rozgrywania partii szachów zmarł Iwan IV Groźny, wielki książę moskiewski, który jako pierwszy przybrał tytuł cara. Prowadził agresywną politykę rozwoju terytorialnego swojego państwa, zaanektował Chanat Kazański i Chanat Astrachański, zaatakował zakon krzyżacki w Inflantach, za panowania Zygmunta II Augusta i Stefana Batorego toczył liczne wojny z Litwą i Polską, zakończone w 1582 r. pokojem w Jamie Zapolskim. Bezskutecznie starał się o rękę Anny Jagiellonki, a podczas elekcji 1573 r. - o koronę Rzeczypospolitej. </content>
<location>Moskwa</location>
<geo>55.7549,37.6227</geo>
<people>Iwan IV Groźny</people>
<keywords>Rosja</keywords>
<sources>
<value>Wikipedia</value>
<url>https://pl.wikipedia.org/wiki/Iwan_IV_Gro%C5%BAny</url>
</sources>
</HistoricalEvent>
- uzupełnić dane
- refactoring