Beitzah/nearby-business-search
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: add README.md

Browse Source
This commit is contained in:
Yehoshua Sandler 2025-05-02 13:25:54 -05:00
parent 023a289dc1
commit 7b8728e369
1 changed files with 31 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md Normal file
View File

@ -0,0 +1,31 @@
# nearby-business-search
Simple Go script to query Google Maps API `Nearby Search API` to gather data for target company research.
Exports this data to an `.xlsx` spreadsheet.
## Setup
```bash
cp .env.example .env
```
There are still some fields that I plan to move to the `.env` for configuring, but the majority of them are
there now.
A Google project API key will be needed.
Be cautious of setting very large `MAX_RESULTS` as Google will eventually charge for this. Keep the number low
if you are testing.
## Run
```bash
go run .
```
Or build it first.
After you run the program, you will see logs stepping through stages of the progress. A simplified table will
be printed out to the terminal and the detailed `.xlsx` will be created based on what ever file name you gave
in the `.env`