diff --git a/README.md b/README.md index 58afb71..c81d383 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Amateur Radio meta spotting tool, name TBD +# (S)pothole *Work in progress.* diff --git a/core/constants.py b/core/constants.py index b2aa734..c572c8e 100644 --- a/core/constants.py +++ b/core/constants.py @@ -1,7 +1,7 @@ from data.band import Band # General software -SOFTWARE_NAME = "Metaspot by M0TRT" +SOFTWARE_NAME = "Spothole by M0TRT" SOFTWARE_VERSION = "0.1" # Sources diff --git a/webassets/apidocs/openapi.yml b/webassets/apidocs/openapi.yml index 75a2bb0..ae37128 100644 --- a/webassets/apidocs/openapi.yml +++ b/webassets/apidocs/openapi.yml @@ -1,8 +1,10 @@ openapi: 3.0.4 info: - title: Unnamed Spotting API + title: Spothole API description: |- - A utility to aggregate spots from amateur radio DX clusters and xOTA spotting sites, and provide an open JSON API as well as a website to browse the data. + Spothole is a utility to aggregate "spots" from amateur radio DX clusters and xOTA spotting sites, and provide an open JSON API as well as a website to browse the data. + + While there are other web-based interfaces to DX clusters, and sites that aggregate spots from various outfoor activity programmes for amateur radio, Spothole differentiates itself by supporting a large number of data sources, and by being "API first" rather than just providing a web front-end. This allows other software to be built on top of it. Spothole itself is also open source, Public Domain licenced code that anyone can take and modify. contact: email: ian@ianrenton.com license: @@ -10,7 +12,7 @@ info: url: https://unlicense.org/#the-unlicense version: 0.1 servers: - - url: https://metaspot.m0trt.radio/api + - url: https://spothole.m0trt.radio/api paths: /spots: get: diff --git a/webassets/css/style.css b/webassets/css/style.css index c1ad48e..7aaaaf3 100644 --- a/webassets/css/style.css +++ b/webassets/css/style.css @@ -1,5 +1,11 @@ -div#table-container { - width: 80%; +#info-container{ + width: 100%; + display: none; +} + +@media (min-width: 768px) { + #info-container{ + max-width: 60em; margin: 0 auto; - overflow: scroll; + } } \ No newline at end of file diff --git a/webassets/index.html b/webassets/index.html index 40e5e25..ad5472c 100644 --- a/webassets/index.html +++ b/webassets/index.html @@ -4,7 +4,7 @@ - Unnamed spot tool + Spothole +
- Unnamed Spot Tool + Spothole
+ +
+ +
+

About Spothole

+

Spothole is a utility to aggregate "spots" from amateur radio DX clusters and xOTA spotting sites, and provide an open JSON API as well as a website to browse the data.

+

While there are several other web-based interfaces to DX clusters, and sites that aggregate spots from various outfoor activity programmes for amateur radio, Spothole differentiates itself by supporting a large number of data sources, and by being "API first" rather than just providing a web front-end. This allows other software to be built on top of it.

+

The API is deliberately well-defined with an OpenAPI specification and auto-generated API documentation. The API delivers spots in a consistent format regardless of the data source, freeing developers from needing to know how each individual data source presents its data.

+

Spothole itself is also open source, Public Domain licenced code that anyone can take and modify. The source code is here.

+

Supported data sources include DX Clusters, the Reverse Beacon Network (RBN), the APRS Internet Service (APRS-IS), POTA, SOTA, WWFF, GMA, WWBOTA, HEMA, and Parks 'n' Peaks.

+

The software was written by Ian Renton, MØTRT.

+

« Back to the spots table

+
+ +
+ +
-
- - diff --git a/webassets/js/code.js b/webassets/js/code.js index 298b949..8d91a4c 100644 --- a/webassets/js/code.js +++ b/webassets/js/code.js @@ -38,4 +38,9 @@ function escapeHtml(str) { }; return str.replace(/[&<>"'`]/g, escapeCharacter); -} \ No newline at end of file +} + + +// Show/hide info block +function showInfo() { $("#info-container").show(); $("#table-container").hide(); } +function hideInfo() { $("#table-container").show(); $("#info-container").hide(); } \ No newline at end of file