countrycity

KO | EN

gitlite — search

#javascript #python #hacktoberfest #ai #typescript #llm #rust #macos #windows #awesome #awesome-list #vue #security #open-source

(★ 101)

:earth_americas: Geodata API - Get countries, and cities to plug in drop-downs.

File Explorer

Download Latest Version (.zip)

- - bug_report.md
  - feature_request.md
- - actions.yml
- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- dependabot.yml
- PULL_REQUEST_TEMPLATE.md
- - Location.php
- geo.json
- index.html
- .htaccess
- index.php
- dependencies.php
- middleware.php
- routes.php
- settings.php
- cities.php
- cities_search.php
- countries.php
- countries_search.php
- home.php
- bootstrap.php
.gitignore
.htaccess
composer.json
composer.lock
index.php
LICENSE
phpunit.xml.dist
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Country City API  
[![Build Status](https://github.com/shivammathur/countrycity/workflows/Tests/badge.svg)](https://github.com/shivammathur/countrycity/actions)
[![Code Climate](https://codeclimate.com/github/shivammathur/countrycity/badges/gpa.svg)](https://codeclimate.com/github/shivammathur/countrycity)
[![codecov](https://codecov.io/gh/shivammathur/countrycity/branch/master/graph/badge.svg)](https://codecov.io/gh/shivammathur/countrycity)
[![License](https://poser.pugx.org/shivammathur/countrycity/license)](https://raw.githubusercontent.com/shivammathur/countrycity/main/license.md)

Geodata API to get the list of countries and cities in the world. This can be plugged in country and city picker drop-downs in forms. You can find a [select2](https://select2.org/) implementation [here](https://shivammathur.github.io/countrycity/). Code for this implementation is in [`example`](example) directory.

### :zap: Installing the CountryCity API

- Make sure you have PHP 7.4 or newer.
```bash
$ php -v
```
- Download this API using [composer](https://getcomposer.org/download/) using the command below.
```bash
composer global require shivammathur/countrycity "dev-main"
```
- Then install the API by executing the command below.
```bash
composer create-project shivammathur/countrycity countrycity "dev-main" --prefer-dist
```
- You are all set, you can use this API.

### :hash: API Endpoints

All API responses are in `json` format.

- Get all countries
```bash
/countries

# Without URL Rewriting
/index.php/countries
```

- Get all countries containing a search keyword
```bash
/countries/{search_keyword}

# Without URL Rewriting
/index.php/countries/{search_keyword}
```

- Get all cities in a country 
```bash
/cities/{country}

# Without URL Rewriting
/index.php/cities/{country}
```

- Get all cities in a country containing a search keyword
```bash
/cities/{country}/{search_keyword}

# Without URL Rewriting
/index.php/cities/{country}/{search_keyword}
```

### :sparkles: Rest API Features
- Built using Slim micro framework.
- Caching enabled with following headers
  - ETag
  - Expires
  - Last-Modified
- Fast and lightweight API
- PSR 7 Complaint
- CORS Middleware

### :cloud: Hosting configuration
Here are the [Configuration Instructions](http://www.slimframework.com/docs/v3/start/web-servers.html) if you want to host this on your server.

### :wrench: Error Format

If there is an error in the API, you will get an error in `json` format as response
```json
{"error":"true", "message": "error message here"}
```

### :rotating_light: Testing
```bash
$ vendor/bin/phpunit --configuration phpunit.xml.dist
```

## :scroll: License

The scripts and documentation in this project are released under the [MIT License](LICENSE). This project has multiple [dependencies](https://github.com/shivammathur/countrycity/network/dependencies) and their licenses can be found in their respective repositories.

## :+1: Contributions

Contributions are welcome! See [Contributor's Guide](.github/CONTRIBUTING.md).

## :sparkling_heart: Support this project

- Please star the project and share it with the community.
- Support the project by sponsoring my work on [GitHub sponsors](https://github.com/sponsors/shivammathur).

countrycity

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

countrycity

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README