Skip to content

Latest commit

 

History

History
44 lines (27 loc) · 1.38 KB

README.md

File metadata and controls

44 lines (27 loc) · 1.38 KB

Test API

Departments and Municipalities of El Salvador

An API to make queries about El Salvador departaments and its municipalities, incluides resources like zip-codes,iso-codes and images. Developed with FastAPI. This is used for api-el-salvador-ui as backend.

Service 🪐

You can consume it from this url. Just check the documentation at the /docs endpoint to learn how to use it and its endpoints.

On premise 🏠

If you want to use it locally, read bellow.

Requirements:

# Install dependencies
pip install -r requirements

Test:

After requirements installation and environment variables assignations, check if all is working. Execute this code to check if you are connected with your DB and if have dependencies correctly installed.

pytest

then, start server:

uvicorn app.main:app --reload

Note

Check wiki section for technical information

Other 📚

Departaments with its municipalities were taken from DepMun-El-Salvador database, check it.


🎍 ~