geo-data-api/index.html at main · asterodigital/geo-data-api · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
<!DOCTYPE html>
<html lang="en">

<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>Geo-Data API - Static JSON API Generator</title>
  <meta name="description"
    content="Generate a static JSON API for geographic data including countries, states, and cities that can be hosted on any CDN. Transform geographic datasets into a small, cacheable, CDN-ready API with search capabilities.">

  <meta name="author" content="Astero Digital">
  <meta name="robots" content="index, follow">


  <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/css/bootstrap.min.css" rel="stylesheet">
  <style>
    html,
    body {
      min-height: 100vh;
      margin: 0;
      padding: 0;
    }

    body {
      display: flex;
      flex-direction: column;
    }

    .content-wrapper {
      flex: 1;
    }

    footer {
      margin-top: auto;
    }
  </style>
</head>

<body>
  <nav class="navbar navbar-expand-lg navbar-dark bg-dark">
    <div class="container">
      <a class="navbar-brand" href="/">🌍 Geo-Data API</a>
      <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarNav"
        aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation">
        <span class="navbar-toggler-icon"></span>
      </button>
      <div class="collapse navbar-collapse" id="navbarNav">
        <div class="navbar-nav ms-auto">
          <a class="nav-link active" href="./">Home</a>
          <a class="nav-link" href="demo/demo.html">Demo</a>
          <a class="nav-link" href="https://github.com/asterodigital/geo-data-api" target="_blank"
            rel="noopener noreferrer">
            🐙 GitHub
          </a>
        </div>
      </div>
    </div>
  </nav>

  <div class="content-wrapper">
    <div class="container py-5">
      <div class="text-center mb-5">
        <h1 class="display-4 display-5">🌍 Geo-Data API</h1>
        <p class="lead">Generate a static JSON API for geographic data including countries, states, and cities that can
          be hosted on any CDN</p>
        <p class="text-muted">Transform geographic datasets into a small, cacheable, CDN-ready API with search
          capabilities</p>
        <div class="mt-3">
          <span class="badge bg-primary me-2">v1.0.0</span>
          <span class="badge bg-success me-2">MIT License</span>
          <span class="badge bg-info">CDN Ready</span>
        </div>
      </div>

      <div class="row text-center mb-4">
        <div class="col-6 col-md-4">
          <h2 class="h1">195+</h2>
          <p class="mb-0">Countries</p>
        </div>
        <div class="col-6 col-md-4">
          <h2 class="h1">5000+</h2>
          <p class="mb-0">States/Provinces</p>
        </div>
        <div class="col-12 col-md-4">
          <h2 class="h1">100K+</h2>
          <p class="mb-0">Cities</p>
        </div>
      </div>

      <div class="text-center mb-4">
        <h4 class="mb-3">🏷️ Keywords & Tags</h4>
        <div class="d-flex flex-wrap justify-content-center gap-2 mb-3">
          <span class="badge bg-secondary">api</span>
          <span class="badge bg-secondary">json</span>
          <span class="badge bg-secondary">psql</span>
          <span class="badge bg-secondary">state</span>
          <span class="badge bg-secondary">states</span>
          <span class="badge bg-secondary">cities</span>
          <span class="badge bg-secondary">region</span>
          <span class="badge bg-secondary">country</span>
          <span class="badge bg-secondary">regions</span>
          <span class="badge bg-secondary">countries</span>
          <span class="badge bg-secondary">generator</span>
          <span class="badge bg-secondary">hacktoberfest</span>
          <span class="badge bg-secondary">world-regions</span>
          <span class="badge bg-secondary">geographical-data</span>
          <span class="badge bg-secondary">country-state-city</span>
          <span class="badge bg-secondary">countries-states-cities</span>
        </div>
      </div>

      <div class="text-center mb-3">
        <a href="demo/demo.html" class="btn btn-primary btn-lg me-3 mb-3">🚀 Try Interactive Demo</a>
        <a href="https://github.com/asterodigital/geo-data-api" class="btn btn-secondary btn-lg me-3 mb-3">📖 View
          on
          GitHub</a>
      </div>

      <div class="row mb-4">
        <div class="col-12 col-lg-6 mb-4 mb-lg-0">
          <div class="card h-100">
            <div class="card-header bg-primary text-white">
              <h3 class="card-title mb-0 h5 h4-md">🚀 Quick Start</h3>
            </div>
            <div class="card-body">
              <p class="card-text">Get started with our API in seconds:</p>
              <pre class="bg-dark text-light p-3 rounded small"><code>// Get all countries
fetch('/api/v1/countries.json')
  .then(response => response.json())
  .then(data => console.log(data));

// Get country by ISO2
fetch('/api/v1/countries/us.json')
  .then(response => response.json())
  .then(data => console.log(data));</code></pre>
            </div>
          </div>
        </div>

        <div class="col-12 col-lg-6">
          <div class="card h-100">
            <div class="card-header bg-success text-white">
              <h3 class="card-title mb-0 h5 h4-md">📡 API Endpoints</h3>
            </div>
            <div class="card-body">
              <h5 class="h6">Countries</h5>
              <ul class="list-unstyled mb-3">
                <li><code class="text-primary small">GET /api/v1/countries.json</code> - All countries</li>
                <li><code class="text-primary small">GET /api/v1/countries/{iso2}.json</code> - Single country</li>
              </ul>

              <h5 class="h6">States</h5>
              <ul class="list-unstyled mb-3">
                <li><code class="text-primary small">GET /api/v1/states/{iso3166_2}.json</code> - Single state</li>
                <li><code class="text-primary small">GET /api/v1/states/country/{iso2}.json</code> - States by country
                </li>
              </ul>

              <h5 class="h6">Cities</h5>
              <ul class="list-unstyled">
                <li><code class="text-primary small">GET /api/v1/cities/batch/{batchId}.json</code> - Cities in batches
                </li>
                <li><code class="text-primary small">GET /api/v1/cities/country/{iso2}.json</code> - Cities by country
                </li>
                <li><code class="text-primary small">GET /api/v1/cities/state/{iso3166_2}.json</code> - Cities by state
                </li>
              </ul>
            </div>
          </div>
        </div>
      </div>

      <div class="row mb-4">
        <div class="col-12">
          <div class="card">
            <div class="card-header bg-info text-white">
              <h3 class="card-title mb-0 h5">🔧 Built With</h3>
            </div>
            <div class="card-body">
              <div class="row text-center">
                <div class="col-md-4 mb-3">
                  <h6 class="text-primary">Runtime</h6>
                  <p class="mb-0">Node.js</p>
                </div>
                <div class="col-md-4 mb-3">
                  <h6 class="text-primary">Dependencies</h6>
                  <ul class="list-unstyled small mb-0">
                    <li>fs-extra: ^11.3.1</li>
                    <li>lodash: ^4.17.21</li>
                  </ul>
                </div>
                <div class="col-md-4 mb-3">
                  <h6 class="text-primary">Dev Dependencies</h6>
                  <ul class="list-unstyled small mb-0">
                    <li>prettier: ^3.6.2</li>
                  </ul>
                </div>
              </div>
            </div>
          </div>
        </div>
      </div>

    </div>

  </div>

  <footer class="text-center py-3 bg-light">
    <p class="mb-2">&copy; 2025 Geo-Data API</p>
    <p class="mb-0 small text-muted">
      Built by <a href="https://asterodigital.com" target="_blank" rel="noopener noreferrer"
        class="text-decoration-none">Astero Digital</a> |
      Licensed under <a href="https://opensource.org/licenses/MIT" target="_blank" rel="noopener noreferrer"
        class="text-decoration-none">MIT</a>
    </p>
  </footer>

  <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/js/bootstrap.bundle.min.js"></script>
</body>

</html>