# AGENTS.md

A fast reverse proxy to help you expose a local server behind a NAT or firewall to the internet.

## Setup

```
go mod download
```

## Commands

```
make build      # produce a build
make env
make web
make web-ci
make frps-web
make frpc-web
```

## Layout

- `pkg/`    186 source files
- `web/`    95 source files
- `test/`   70 source files
- `server/` 44 source files
- `client/` 33 source files
- `cmd/`    10 source files

## Conventions

- Tests live alongside the code they cover, following `client/config_manager_test.go`.
- CI defines what passing means. See `.github/workflows/build-and-push-image.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.