Important

Under Development | Versión en desarrollo.

API - Códigos Postales de México

Consulta colonias, municipios, códigos postales y coordenadas.
Explora la documentación »
View Demo · Report Bug · Request Feature

Tabla de contenido

1. Sobre el Proyecto
   • 🛠️- Herramientas Utilizadas
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

This open-source project aims to simplify the process of finding and accessing information about neighborhoods (colonias) in Mexico. Users can efficiently search for colonias using various methods: by postal code, by name (partial or full), or by geographic coordinates. Additionally, the tool provides the functionality to obtain the geographic coordinates of a specific colonia. This project is intended to be a valuable resource for developers, researchers, and anyone needing quick access to colonia data in Mexico.

Descripción

Este proyecto de código abierto tiene como objetivo facilitar la búsqueda y consulta de información sobre las colonias en México. A través de diferentes métodos de búsqueda, los usuarios podrán acceder a datos relevantes de cada colonia de forma rápida y sencilla.

Funcionalidades principales

• Búsqueda por código postal: Permite encontrar información detallada de una colonia específica ingresando su código postal.
• Búsqueda por nombre de colonia: Facilita la búsqueda de colonias ingresando parte de su nombre. El programa mostrará sugerencias y resultados relevantes.
• Búsqueda por coordenadas: Permite identificar la colonia a la que pertenecen unas coordenadas geográficas dadas.
• Obtención de coordenadas: Permite obtener las coordenadas geográficas de una colonia específica.

Herramientas Utilizadas

• NodeJS
• ExpressJS
• TypeScript

---

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/open-mexico/mexpost.git

2. Install NPM packages

   yarn
   # o puedes usar npm
   npm install

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Licencia 📄

Este proyecto está bajo la Licencia MIT - mira el archivo LICENSE para detalles

Expresiones de Gratitud 🤗😻

• Comparte con otros éste proyecto 🗣📢
• Invitame una cerveza 🍺 o un café ☕😏
• Da las gracias públicamente 🤓
• etc 🤔🙃

---

Made with ❤️ macarthuror - @MacarthurOr - [email protected]