Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chitoku-k/hoarder
Collects your favorite media and organizes them with the hierarchical tag system.
https://github.com/chitoku-k/hoarder
Last synced: 2 months ago
JSON representation
Collects your favorite media and organizes them with the hierarchical tag system.
- Host: GitHub
- URL: https://github.com/chitoku-k/hoarder
- Owner: chitoku-k
- License: apache-2.0
- Created: 2023-07-12T18:36:04.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-10-16T01:29:28.000Z (2 months ago)
- Last Synced: 2024-10-17T14:25:05.649Z (2 months ago)
- Language: Rust
- Homepage:
- Size: 2.38 MB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
Hoarder
=======
[![][workflow-badge]][workflow-link]
Collects your favorite media and organizes them with the hierarchical tag system.
## Set up
### Development
```bash
$ yarn && yarn codegen
$ docker compose up -d --build
$ docker compose exec api hoarder migration apply
```
### Production
```bash
$ docker buildx bake -f docker-bake.hcl
$ docker run --rm -it ghcr.io/chitoku-k/hoarder/api migration apply
```
## Configuration
### API
#### Global Options
- `--locale` (`LOCALE`): [Unicode locale identifier](https://unicode.org/reports/tr35/tr35.html#Unicode_locale_identifier) for collation order
- `--log-level` (`LOG_LEVEL`): Log level as in [RUST\_LOG](https://docs.rs/env_logger/latest/env_logger/)
The following environment variables can be used to configure PostgreSQL connection:
- `PGHOST`: Hostname
- `PGPORT`: Port number
- `PGUSER`: Username
- `PGPASSWORD`: Password
- `PGDATABASE`: Database name
- `PGSSLROOTCERT`: Path to the root CA
- `PGSSLCERT`/`PGSSLKEY`: Path to the client certificate and private key in PKCS#8 format
- `PGSSLMODE`: SSL mode
- `PGAPPNAME`: Application name
#### Serve API
```
$ hoarder [serve] [OPTIONS]
```
The following command line options (or environment variables) can be used to configure API:
- `--port` (`PORT`): Port number (**required**)
- `--media-root-dir` (`MEDIA_ROOT_DIR`): Path to the media directory (**required**)
- `--media-root-url` (`MEDIA_ROOT_URL`): Public URL for media
- `--tls-cert`/`--tls-key` (`TLS_CERT`/`TLS_KEY`): Path to TLS certificate and private key for HTTPS
#### Manage GraphQL schema
To show GraphQL schema in SDL (Schema Definition Language):
```
$ hoarder schema print
```
#### Databse Migration
To execute database migration:
```
$ hoarder migration [OPTIONS] (apply | drop | list | revert)
```
### UI
#### Options
The following environment variables can be used to configure UI:
- `API_URL`: URL for API (**required**)
- `PUBLIC_URL`: Public URL for UI (**required**)
- `BASE_URL`: Base URL for UI (**required**)
## Testing
### API
Install [cargo-make] first in case it's not installed.
```bash
$ cargo install cargo-make
```
Run all tests.
```bash
$ cargo make test
```
## Credits
### Icon
Icon made by [Freepik] from [www.flaticon.com][flaticon]
[workflow-link]: https://github.com/chitoku-k/hoarder/actions?query=branch:master
[workflow-badge]: https://img.shields.io/github/actions/workflow/status/chitoku-k/hoarder/ci.yml?branch=master&style=flat-square
[cargo-make]: https://github.com/sagiegurari/cargo-make
[Freepik]: https://www.flaticon.com/authors/freepik
[flaticon]: https://www.flaticon.com/