32 lines
667 B
Markdown
32 lines
667 B
Markdown
# Nuthatch
|
|
|
|
Small web UI for personal and shared S3-compatible storage.
|
|
|
|
Made for a personal homelab. Shared as-is.
|
|
|
|
## Build and test
|
|
|
|
Install the [required tools](docs/spec/testing.md), then run:
|
|
|
|
```sh
|
|
cabal build exe:nuthatch
|
|
make test
|
|
npm --prefix web ci
|
|
make test-frontend check-frontend build-frontend
|
|
```
|
|
|
|
Full check, including local kind clusters:
|
|
|
|
```sh
|
|
make check-v1
|
|
```
|
|
|
|
## Docs
|
|
|
|
- [Behavior and design](docs/spec/nuthatch.md)
|
|
- [Configuration and interfaces](docs/spec/contracts.md)
|
|
- [Mutation protocol](docs/protocol/Nuthatch.tla)
|
|
|
|
## License
|
|
|
|
[BSD 3-Clause](LICENSE). See [`THIRD_PARTY_NOTICES.txt`](THIRD_PARTY_NOTICES.txt) for bundled dependencies.
|