Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/caddishouse/reader
A web-based document reader.
https://github.com/caddishouse/reader
elixir liveview phoenix
Last synced: about 1 month ago
JSON representation
A web-based document reader.
- Host: GitHub
- URL: https://github.com/caddishouse/reader
- Owner: caddishouse
- Created: 2022-09-05T15:13:08.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-17T11:45:50.000Z (4 months ago)
- Last Synced: 2024-08-17T12:51:36.571Z (4 months ago)
- Topics: elixir, liveview, phoenix
- Language: Elixir
- Homepage: https://www.caddishouse.com
- Size: 1.29 MB
- Stars: 13
- Watchers: 0
- Forks: 0
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- fucking-awesome-elixir - Caddishouse - A web-based document reader that connects to your cloud storage accounts using Phoenix/LiveView. (Applications)
- awesome-elixir - Caddishouse - A web-based document reader that connects to your cloud storage accounts using Phoenix/LiveView. (Applications)
README
# Caddishouse
Caddishouse is a web-based document reader. It connects to your cloud-based storage accounts and lets you import documents to read. You can use it by accessing https://www.caddishouse.com OR set it up locally.
It does the following:
* Access your documents in any number of cloud-based storage accounts quickly.
* Saves the current page you're on for each document.
* Uses less bandwidth/CPU/memory than current readers (TBD, see issue: (TODO)) and loads faster.
In order to support this last requirement, it gives up the following features which many other document readers support (these may be implemented at a future point):
* It is not possible to search a document
* It is not possible to select/copy text
* Annotations are not supported
See ROADMAP for planned features.
## Screenshot
## Quick Start
* Install dependencies with `mix deps.get`
* Create and migrate your database with `mix ecto.setup`
* Start Phoenix endpoint with `mix phx.server` or inside IEx with `iex -S mix phx.server`
* Start your Minio server (see Set-up Minio), or configure an alternative (see Configuration).
Now you can visit [`localhost:3333 `](http://localhost:3333) from your browser.
## Configuration
```
# ENVARS
MINIO_HOST=localhost
MINIO_PORT=9001
MINIO_ACCESS_KEY=
MINIO_SECRET_KEY=
ASSET_URL=http://localhost:9001
GOOGLE_OAUTH_CLIENT=
GOOGLE_OAUTH_SECRET=
GOOGLE_OAUTH_REDIRECT_URL=http://localhost:3333/auth/google/callback
```
In addition, it's possible to add/implement your own storage solution. While using S3 intead of Minio is simply pointing the host/port/keys to your S3 set-up, you could use an alternative storage solution by implementing the `Caddishouse.Storage` behaviour found in `lib/caddishouse/storage/storage.ex`.
You must then add the following to the config:
```elixir
config :caddishouse,
storage_api: Your.Storage.Module
```
### Adding/removing providers (TODO)
This configuration has yet to be implemented.
## Set-up Minio
```sh
# For MacOSX
$ brew install --cask docker
$ docker run \
-p 9000:9000 \
-p 9001:9001 \
-e "MINIO_ROOT_USER=admin" \
-e "MINIO_ROOT_PASSWORD=admin" \
quay.io/minio/minio server /data --console-address ":9001"
```
Access http://localhost:9001/buckets, create a bucket called `uploads`.
Go to http://localhost:9001/identity/account, create a service account.
See Configuration.
## Gotchas
### When committing, I get an error that there are dependencies that are out of sync.
Run the following: `mix git_hooks.install`
# Credits
Primarily developed by Alex Fraiha (Fraih001) and aef-.