humbertn / country-info

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Description

This is an API that connects to a postgres database more here

Pre-requisites

Please follow the instructions on the datalayer repo to run the database locally.

This api runs on port 3000

To Run

To run this project it is required to have Docker installed.

Run the following command on the root folder

docker compose up -d

API should be accesible via localhost:3000

Endpoints

GET /state

Returns all States for USA.

GET /state/{stateName}

Returns one specific state filtered by stateName.

GET /state/{stateName}/county

Returns all counties for an specific state filtered by stateName.

GET /state/{stateName}/county/{countyName}

Returns one specific county filtered by countyName and stateName.

About

License:GNU General Public License v3.0


Languages

Language:JavaScript 96.0%Language:Dockerfile 4.0%