Skip to content

updated arch #196

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ryansurf merged 1 commit into from
Apr 10, 2026
Merged

updated arch #196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Inspired by [wttr.in](https://github.com/chubin/wttr.in) · [Documentation](http

## 💻 Usage

There are two ways to use cli-surf: install it as a CLI tool via pipx, or run the server and access it via API/browser.
There are several ways to use cli-surf: install it as a CLI tool via pipx, hit the public API, or run the server locally and access it via API/browser.

### Installing via [pipx](https://pipx.pypa.io/stable/) ([pypi](https://pypi.org/project/cli-surf/))

Expand All @@ -56,7 +56,13 @@ surf --help
surf --location scripps_pier --forecast 4
```

### Running the server and using via API
### Hitting the public API

```
curl https://api.clisurf.com
```

### Running the server locally and using via API

Start the server locally (see [Setup](#️-setup) below), then query it from your browser or CLI:

Expand Down Expand Up @@ -330,6 +336,7 @@ GPT_PROMPT="What are some good places to eat around this surf spot?"
| Optional frontend | Streamlit |
| Packaging | Poetry, pipx |
| Containerization | Docker / Docker Compose |
| Cloud | AWS (Lambda, ECR, API Gateway), CloudFlare (DNS resolver), GoDaddy (register domain name) |
Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot Apr 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue (typo): Correct "CloudFlare" capitalization to the official "Cloudflare".

Suggested change
| Cloud | AWS (Lambda, ECR, API Gateway), CloudFlare (DNS resolver), GoDaddy (register domain name) |
| Cloud | AWS (Lambda, ECR, API Gateway), Cloudflare (DNS resolver), GoDaddy (register domain name) |


---

Expand Down
Binary file modified docs/architecture.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading