How to use docker and test API endpoints

[miguel-merlin]

Using docker

Make sure you have docker installed. You can verify this by running

docker -v

If you don't have docker installed, you can download it here:
mac
windows

Make sure you have the most up-to-date version of the codebase. In the root directory of the repo, run:

git pull

To initialize the docker container, run

docker-compose up

After running the previous command, you should see this message:

nycmesh-node-visualizer-postgres-1  | 2023-11-06 20:28:10.726 UTC [1] LOG:  listening on IPv4 address "0.0.0.0", port 5432
nycmesh-node-visualizer-postgres-1  | 2023-11-06 20:28:10.726 UTC [1] LOG:  listening on IPv6 address "::", port 5432
nycmesh-node-visualizer-postgres-1  | 2023-11-06 20:28:10.728 UTC [1] LOG:  listening on Unix socket "/var/run/postgresql/.s.PGSQL.5432"
nycmesh-node-visualizer-postgres-1  | 2023-11-06 20:28:10.748 UTC [67] LOG:  database system was shut down at 2023-11-06 20:28:10 UTC
nycmesh-node-visualizer-postgres-1  | 2023-11-06 20:28:10.766 UTC [1] LOG:  database system is ready to accept connections

If you see this message, you have successfully started docker. Now you have an instance of Postgres running in your local. The docker-compose runs an SQL script that initializes the database with default data. The script creates the tables specified in #30.

localhost:3000/api/{name_of_endpoint}