https://github.com/ringsaturn/tzf-server
Simple server convert longitude&latitude to timezone name
https://github.com/ringsaturn/tzf-server
latitude longitude timezone-library timezone-picker tzf
Last synced: 11 months ago
JSON representation
Simple server convert longitude&latitude to timezone name
- Host: GitHub
- URL: https://github.com/ringsaturn/tzf-server
- Owner: ringsaturn
- License: unlicense
- Archived: true
- Created: 2022-05-30T11:22:48.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-16T22:59:17.000Z (about 1 year ago)
- Last Synced: 2025-07-29T01:47:46.329Z (11 months ago)
- Topics: latitude, longitude, timezone-library, timezone-picker, tzf
- Language: Go
- Homepage: https://tzf-server.ringsaturn.me/web/click
- Size: 1010 KB
- Stars: 5
- Watchers: 1
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Simple server convert longitude&latitude to timezone name
> [!NOTE]
>
> It's designed as a debugger tool for package
> [tzf](https://github.com/ringsaturn/tzf), not production ready.
- [Quick Start](#quick-start)
- [Install](#install)
- [Install via `go install`](#install-via-go-install)
- [Download from release page](#download-from-release-page)
- [Install from Docker Hub](#install-from-docker-hub)
- [Usage](#usage)
- [Web Pages](#web-pages)
- [All supported timezone names](#all-supported-timezone-names)
- [\[Experiment\] Clickable debugger](#experiment-clickable-debugger)
- [HTTP API](#http-api)
- [Lookup Location's timezone](#lookup-locations-timezone)
- [Lookup Location's timezones](#lookup-locations-timezones)
- [All supported timezone names](#all-supported-timezone-names-1)
- [Redis Protocol Commands](#redis-protocol-commands)
- [`redis-cli`](#redis-cli)
- [`redis-py`](#redis-py)
## Quick Start
### Install
#### Install via `go install`
```bash
go install github.com/ringsaturn/tzf-server@latest
```
#### Download from release page
Please visit to get latest
release.
#### Install from [Docker Hub](https://hub.docker.com/r/ringsaturn/tzf-server)
```bash
docker pull ringsaturn/tzf-server
```
### Usage
```console
Usage of tzf-server:
-disable-print-route
Disable Print Route
-hertz-prometheus-host-port string
Hertz Prometheus Host&Port (default "0.0.0.0:8090")
-hertz-prometheus-path string
Hertz Prometheus Path (default "/hertz")
-http-addr string
HTTP Host&Port (default "0.0.0.0:8080")
-path string
custom data
-prometheus-enable-go-coll
Enable Go Collector (default true)
-prometheus-host-port string
Prometheus Host&Port (default "0.0.0.0:2112")
-prometheus-path string
Prometheus Path (default "/metrics")
-redis-addr string
Redis Server Host&Port (default "localhost:6380")
-type int
which finder to use Polygon(0) or Fuzzy(1)
```
For example, start
[DefaultFinder](https://pkg.go.dev/github.com/ringsaturn/tzf#DefaultFinder)
server:
```bash
tzf-server
```
Or start [FuzzyFinder](https://pkg.go.dev/github.com/ringsaturn/tzf#FuzzyFinder)
based server:
```bash
tzf-server -type 1
```
## Web Pages
> [!NOTE]
>
> Please note that the live demo below is runned on a free plan of Render, so it
> may take a while to start the server. Please do not use it for production.
### All supported timezone names
- [`http://localhost:8080/web/tzs/all`](http://localhost:8080/web/tzs/all)
- Live demo:
### [Experiment] Clickable debugger
- [`http://localhost:8080/web/click`](http://localhost:8080/web/click)
- Live demo:
I have little knowledge about frontend development so it's just a experiment,
most codes are written by ChatGPT 3.5. You can access the prompts from
[gist](https://gist.github.com/ringsaturn/12b5509d80f69e7bca13da8745f7ce15).
## HTTP API
> [!NOTE]
>
> Please note that the live demo below is runned on a free plan of Render, so it
> may take a while to start the server. Please do not use it for production.
A swagger UI can be found at
[`http://localhost:8080/swagger/index.html`](http://localhost:8080/swagger/index.html).
Or live demo:
### Lookup Location's timezone
```bash
curl "http://localhost:8080/api/v1/tz?longitude=116.3883&latitude=39.9289"
```
or live demo:
```bash
curl "https://tzf-server.ringsaturn.me/api/v1/tz?longitude=116.3883&latitude=39.9289"
```
Output:
```json
{
"timezone": "Asia/Shanghai",
"abbreviation": "CST",
"offset": "28800s"
}
```
### Lookup Location's timezones
```bash
curl "http://localhost:8080/api/v1/tzs?longitude=87.6168&latitude=43.8254"
```
or live demo:
```bash
curl "https://tzf-server.ringsaturn.me/api/v1/tzs?longitude=87.6168&latitude=43.8254"
```
Output:
```json
{
"timezones": [
{
"timezone": "Asia/Shanghai",
"abbreviation": "CST",
"offset": "28800s"
},
{
"timezone": "Asia/Urumqi",
"abbreviation": "+06",
"offset": "21600s"
}
]
}
```
### All supported timezone names
```bash
curl "http://localhost:8080/api/v1/tzs/all"
```
or live demo:
```bash
curl "https://tzf-server.ringsaturn.me/api/v1/tzs/all"
```
Output:
```jsonc
{
"timezones": [
{
"timezone": "Africa/Abidjan",
"abbreviation": "GMT",
"offset": "0s"
},
// ...
{
"timezone": "Etc/GMT+12",
"abbreviation": "-12",
"offset": "-43200s"
}
]
}
```
## Redis Protocol Commands
### `redis-cli`
```console
$ redis-cli -p 6380
127.0.0.1:6380> GET_TZ 116.3883 39.9289
Asia/Shanghai
127.0.0.1:6380> GET_TZS 87.4160 44.0400
1) "Asia/Shanghai"
2) "Asia/Urumqi"
```
### `redis-py`
```python
>>> from redis import Redis
>>> rc = Redis.from_url("redis://localhost:6380")
>>> rc.ping()
True
>>> rc.execute_command("get_tz", 116.3883, 39.9289).decode()
'Asia/Shanghai'
>>> rc.execute_command("get_tzs", 87.4160, 44.0400)
[b'Asia/Shanghai', b'Asia/Urumqi']
```