Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jecaro/diverk
An Android app to browse GitHub repositories
https://github.com/jecaro/diverk
android-app haskell reflex-frp
Last synced: about 1 month ago
JSON representation
An Android app to browse GitHub repositories
- Host: GitHub
- URL: https://github.com/jecaro/diverk
- Owner: jecaro
- License: mit
- Created: 2023-08-30T13:24:38.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-29T20:29:45.000Z (2 months ago)
- Last Synced: 2024-10-29T22:48:47.560Z (2 months ago)
- Topics: android-app, haskell, reflex-frp
- Language: Nix
- Homepage: https://diverk.quillet.org
- Size: 634 KB
- Stars: 11
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Diverk
Diverk is a simple app that allows you to browse a GitHub repository on your
Android device. It renders markdown files and is thus mainly used to access
personal notes or documentation written in this format.
It is available on [google play][play] and on the [web][web].
It is able to access private repositories when given a valid access token. We
recommend using [fine-grained access tokens][tokens] for this purpose.
Note that the app uses the GitHub API and is thus subject to rate limiting.
Without a token, the rate limit is 60 requests per hour. It roughly corresponds
to 60 pages per hour. It should be enough for quickly looking up something. But
for a more intensive use, we recommend using a token.
Using a token increases the rate limit to 5,000 requests per hour. More
information about rate limits is available in the [GitHub
documentation][github-rate-limit]. Additionally, to be able to search in a
repository, a token is mandatory. This uses the [search code
feature][github-search-code] of the GitHub API. For this specific feature, the
rate limit is 10 searches per hour.
## Building
The app is written in Haskell using the [obelisk][obelisk] framework.
Start a shell with `ob` command:
```bash
$ nix-shell
```
Run locally the app with:
```bash
$ ob run
```
and go to `http://localhost:8000` to access it.
To hack on the code, [haskell-langage-server][haskell-langage-server] can be
made available in the shell with:
```bash
$ ob shell
```
The Android app can be built with:
```bash
$ nix-build -A android.frontend -o result-android
```
Plug your phone with USB debugging on, then run:
```bash
$ ./result-android/bin/deploy
```
to install the app on the device.
See also the [obelisk documentation][obelisk-android] for more details.
[github-rate-limit]: https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting
[github-search-code]: https://docs.github.com/en/rest/search/search#search-code
[haskell-langage-server]: https://github.com/haskell/haskell-language-server
[obelisk-android]: https://github.com/obsidiansystems/obelisk#android
[obelisk]: https://github.com/obsidiansystems/obelisk
[play]: https://play.google.com/store/apps/details?id=org.jecaro.diverk
[tokens]: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#fine-grained-personal-access-tokens
[web]: https://diverk.quillet.org