Skip to content

Commit

Permalink
Merge pull request #1928 from russellb/docs-code-org-apiserver
Browse files Browse the repository at this point in the history
docs: Add apiserver to the code organization doc
  • Loading branch information
mergify[bot] authored Feb 20, 2024
2 parents 39602e0 + 2d1379d commit 337f203
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/development/code-organization.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,16 @@ is found in the files following this pattern: `internal/nexodus/ctl*.go`.

All of the code for the Nexodus web UI is found under `ui/`.

### The Nexodus API Server

The entrypoint for `apiserver` is in `cmd/main.go`. Most of the code for the API server is found
under `internal/`.

* `internal/routers` - the code for mapping HTTP requests to the code that will handle them.
* `internal/handlers` - the code that handles the HTTP requests as mapped from the request router.
* `internal/database` - the code for managing the database schema and migrations.
* `internal/models` - the data structures that are used to interact with the database.

### Tests

The integration tests are found under `integration-tests/`. Unit tests are found throughout the code base,
Expand Down

0 comments on commit 337f203

Please sign in to comment.