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

There are many great README templates available on GitHub, however, I didn't find one that really suit my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need -- I think this is it.

Here's why:

• Your time should be focused on creating something amazing. A project that solves a problem and helps others
• You shouldn't be doing the same tasks over and over like creating a README from scratch
• You should element DRY principles to the rest of your life 😄

Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have have contributed to expanding this template!

A list of commonly used resources that I find helpful are listed in the acknowledgements.

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/macarthuror/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]