Documentation
¶
Overview ¶
Package backend is the root module for mddb, a local-first markdown database server with file storage, user authentication, and a RESTful HTTP API.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
mddb
command
Package main is the entry point for the mddb server.
|
Package main is the entry point for the mddb server. |
|
Package frontend embeds the compiled SolidJS web UI assets.
|
Package frontend embeds the compiled SolidJS web UI assets. |
|
internal
|
|
|
apiclient
command
Command apiclient generates a TypeScript API client from router.go and handler signatures.
|
Command apiclient generates a TypeScript API client from router.go and handler signatures. |
|
apiroutes
command
Command apiroutes extracts API routes from router.go and generates docs/API.md.
|
Command apiroutes extracts API routes from router.go and generates docs/API.md. |
|
jsonldb
Package jsonldb provides a generic, concurrent-safe, JSONL-backed data store.
|
Package jsonldb provides a generic, concurrent-safe, JSONL-backed data store. |
|
server
Package server implements HTTP routing, middleware, and request handling.
|
Package server implements HTTP routing, middleware, and request handling. |
|
server/dto
Package dto defines API request/response types and error handling.
|
Package dto defines API request/response types and error handling. |
|
server/handlers
Package handlers provides HTTP request handlers for the REST API.
|
Package handlers provides HTTP request handlers for the REST API. |
|
storage/content
Package content provides versioned file storage for the mddb system.
|
Package content provides versioned file storage for the mddb system. |
|
storage/identity
Package identity provides services for user authentication and organization management.
|
Package identity provides services for user authentication and organization management. |
|
utils
Package utils provides shared utility functions across the application.
|
Package utils provides shared utility functions across the application. |
Click to show internal directories.
Click to hide internal directories.