w1cdn/spothole
1
0
Fork 0
mirror of https://git.ianrenton.com/ian/spothole.git synced 2025-10-27 08:49:27 +00:00
Code Issues 11 Packages Projects Releases Wiki Activity

An attempt at naming the software. Closes #12

Browse Source
This commit is contained in:
Ian Renton
2025-09-30 22:03:22 +01:00
parent 4f4c1a9191
commit 6749a97f99
6 changed files with 43 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
webassets/apidocs/openapi.yml
View File

@@ -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:

12
webassets/css/style.css
View File

@@ -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;
}
}

27
webassets/index.html
View File

@@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Unnamed spot tool</title>
<title>Spothole</title>
<link rel="stylesheet" href="css/style.css" type="text/css">
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.8/dist/css/bootstrap.min.css" rel="stylesheet"
@@ -15,26 +15,41 @@
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.8/dist/js/bootstrap.bundle.min.js"
integrity="sha384-FKyoEForCGlyvwx9Hj09JcYn3nv7wiPVlz7YYwJrWVcXK/BmnVDxM+D2scQbITxI"
crossorigin="anonymous"></script>
<script src="js/code.js"></script>
</head>
<body>
<div class="container">
<header class="d-flex flex-wrap justify-content-center py-3 mb-4 border-bottom">
<a href="/" class="d-flex align-items-center mb-3 mb-md-0 me-md-auto text-dark text-decoration-none">
<span class="fs-4">Unnamed Spot Tool</span>
<span class="fs-4">Spothole</span>
</a>
<ul class="nav nav-pills">
<li class="nav-item"><a href="#" class="nav-link">About</a></li>
<li class="nav-item"><a href="#" onclick="showInfo()" class="nav-link">About</a></li>
<li class="nav-item"><a href="/apidocs" class="nav-link">API</a></li>
<li class="nav-item"><a href="#" class="nav-link">Status</a></li>
<li class="nav-item"><a href="#" class="nav-link">Filters</a></li>
</ul>
</header>
<main>
<div id="info-container">
<h3>About Spothole</h3>
<p>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.</p>
<p>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.</p>
<p>The API is deliberately well-defined with an <a href="/apidocs/openapi.yml">OpenAPI specification</a> and auto-generated <a href="/apidocs">API documentation</a>. 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.</p>
<p>Spothole itself is also open source, Public Domain licenced code that anyone can take and modify. <a href="https://git.ianrenton.com/ian/metaspot/">The source code is here</a>.</p>
<p>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.</p>
<p>The software was written by <a href="https://ianrenton.com">Ian Renton, MØTRT</a>.</p>
<p><a href="#" onclick="hideInfo()">&laquo; Back to the spots table</a></p>
</div>
<div id="table-container"></div>
</main>
</div>
<div id="table-container"></div>
<script src="js/code.js"></script>
</body>
</html>

7
webassets/js/code.js
View File

@@ -38,4 +38,9 @@ function escapeHtml(str) {
};
return str.replace(/[&<>"'`]/g, escapeCharacter);
}
}
// Show/hide info block
function showInfo() { $("#info-container").show(); $("#table-container").hide(); }
function hideInfo() { $("#table-container").show(); $("#info-container").hide(); }