https://github.com/kents00/zipkode
Directory of Philippine zip codes
https://github.com/kents00/zipkode
flask-restful python zipcode
Last synced: 5 months ago
JSON representation
Directory of Philippine zip codes
- Host: GitHub
- URL: https://github.com/kents00/zipkode
- Owner: kents00
- License: gpl-3.0
- Created: 2024-01-31T15:08:10.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-18T11:56:53.000Z (about 2 years ago)
- Last Synced: 2025-02-04T18:17:12.321Z (about 1 year ago)
- Topics: flask-restful, python, zipcode
- Language: HTML
- Homepage: https://zipkode.onrender.com/
- Size: 683 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# ZipKode
It's a web app using the Flask framework that lets users search for ZIP codes by regions, provinces, cities, and municipalities in a specific area in the philippines.
### Installation
```bash
// Clone the repository
git clone https://github.com/kents00/ZipKode.git
// installing requirements
pip install -r requirements.txt
//run into your local machine
flask --app app run
```
The application will be accessible at **`http://127.0.0.1:5000/`** in your web browser.
### API
The project provides a simple API for searching ZIP codes.
- **Endpoint**: **`/search`**
- **Method**: GET
- **Parameters**:
- **`search_term`** (required): The term to search for.
**Example Request**:
```bash
// localhost
curl http://127.0.0.1:5000/search?search_term=Manila
// render
curl https://zipkode.onrender.com/search?search_term=Manila
```
**Example Response**:
```json
{
"result": {
"NCR (National Capital Region)": {
"Metro Manila": {
"Manila Bay (Reclamation)": "1308",
"Manila Doctors Village": "1748",
"Manila Memorial Park": "1717"
}
}
},
"search_term": "Manila"
}
```
### Issues
If you're having trouble integrating this code into your machine, [open a new issue](https://github.com/kents00/ZipKode/issues). As this repository continues to develop, it will be easier for more developers to integrate updates and improve overall user performance!