https://github.com/damingerdai/address-go

an address api based on golang
https://github.com/damingerdai/address-go

address chinese deo2ip go

Last synced: 19 days ago
JSON representation

an address api based on golang

• Host: GitHub
• URL: https://github.com/damingerdai/address-go
• Owner: damingerdai
• License: apache-2.0
• Created: 2019-12-01T04:49:52.000Z (about 5 years ago)
• Default Branch: develop
• Last Pushed: 2024-04-19T13:03:14.000Z (8 months ago)
• Last Synced: 2024-04-19T14:28:18.557Z (8 months ago)
• Topics: address, chinese, deo2ip, go
• Language: PLpgSQL
• Homepage:
• Size: 40.7 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# address-go

an address api based on golang

# Get Start

if you want to run this project, these software are required

1. [Docker](https://docs.docker.com/install/)

> if you use the Mac or Windows, please install `Docker Desktop`;

> if you use the Linux, please download [docker-compose](https://docs.docker.com/compose/install/) separately.

2. [Golang](https://golang.org/dl/)

## Install

```bash

git clone https://github.com/damingerdai/address-go.git

```

## Init

### Create Volume

```bash

docker volume create --name=address-go

```

### Create Network

```bash

docker network create address-networks

```

### Docker Compose

run for mysql

```bash

docker compose up mysql

```

### Init data

in `data` folder, exec these sql files to init data

# Run

```bash

make run

```

# Bazel

update repositories

```bash

bazel run //:gazelle

bazel run //:gazelle -- update-repos -from_file=go.mod -to_macro=deps.bzl%go_dependencies

```

build

```

bazel build //cmd/address:address

```

# Data

i use this [data source](https://github.com/wecatch/china_regions)

# bazel

```

 bazel run //:gazelle

 bazel run //:gazelle -- update-repos -from_file=go.mod

 bazel build //cmd/address:address

```

# Roadmap

## 2019.12.30

1. use [golang-standards](https://github.com/golang-standards/project-layout) to refactor the project layout [x]

# Owner

[@大明二代](https://github.com/damingerdai)

# License

[MIT](LICENSE) © 大明二代