diff options
Diffstat (limited to 'fatcat-go')
| -rw-r--r-- | fatcat-go/README.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/fatcat-go/README.md b/fatcat-go/README.md new file mode 100644 index 00000000..ea1166ce --- /dev/null +++ b/fatcat-go/README.md @@ -0,0 +1,23 @@ + +This folder contains source for the fatcat API daemon ("fatcatd"), written in +golang. + + +## Structure + +fatcatd is essentially just glue between two declarative schemas: + +- a postgres-flavor SQL database schema +- an OpenAPI/Swagger REST API definition + + +## Simplifications + +In early development, we'll make at least the following simplifications: + +- authentication (authn and authz) are not enforced and don't have user + interfaces. actual authentication will be eased in via a microservice and/or + oauth to gitlab/github/orcid.org +- "extra" metadata is stored in-entity as JSONB. In the future this might be + broken out to a separate table +- libraries won't be vendored; in the future they will be via a git submodule |