https://github.com/natoboram/leanish
A lean-ish web client for Lemmy.
https://github.com/natoboram/leanish
fediverse lemmy
Last synced: about 1 month ago
JSON representation
A lean-ish web client for Lemmy.
- Host: GitHub
- URL: https://github.com/natoboram/leanish
- Owner: NatoBoram
- License: agpl-3.0
- Created: 2023-07-01T00:07:13.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-04T19:27:43.000Z (12 months ago)
- Last Synced: 2024-05-19T14:35:02.607Z (11 months ago)
- Topics: fediverse, lemmy
- Language: Svelte
- Homepage: https://natoboram.github.io/Leanish/
- Size: 4.02 MB
- Stars: 30
- Watchers: 2
- Forks: 0
- Open Issues: 39
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Leanish
[](https://github.com/NatoBoram/Leanish/actions/workflows/android.yaml) [](https://github.com/NatoBoram/Leanish/actions/workflows/docker.yaml) [](https://github.com/NatoBoram/Leanish/actions/workflows/node.js.yaml) [](https://github.com/NatoBoram/Leanish/actions/workflows/github-pages.yaml) [](https://hub.docker.com/repository/docker/natoboram/leanish) [](https://github.com/NatoBoram/Leanish/releases) [](https://www.npmjs.com/package/@natoboram/leanish) [](https://play.google.com/store/apps/details?id=com.natoboram.leanish) [](https://natoboram.github.io/Leanish/lemm.ee/c/[email protected])
A lean-ish web client for Lemmy.
## Usage
Leanish is currently in alpha. The roadmap to beta is in [the Beta milestone](https://github.com/NatoBoram/Leanish/milestone/1).
There is a client-side rendered deployment at [natoboram.github.io/Leanish](https://natoboram.github.io/Leanish). It can be installed as a Progressive Web App.
Android builds are available in the [Releases](https://github.com/NatoBoram/Leanish/releases) tab. For a more cutting-edge experience, CI builds are available in the [Actions](https://github.com/NatoBoram/Leanish/actions/workflows/android.yaml) tab.
## Deploy
A [docker image](https://hub.docker.com/repository/docker/natoboram/leanish) and a [`npm` package](https://www.npmjs.com/package/@natoboram/leanish) are available for deployment.
```sh
docker pull natoboram/leanish
docker run -p 3000:3000 natoboram/leanish
```
```sh
pnpm install -g @natoboram/leanish
leanish
```
## Build from source
### Docker
```sh
git clone https://github.com/NatoBoram/Leanish.git
cd Leanish
BUILD_BASE= pnpm run docker:build
pnpm run docker:run
```
### Web
```sh
git clone https://github.com/NatoBoram/Leanish.git
cd Leanish
pnpm install
BUILD_ADAPTER=node pnpm run build
node ./build/index.js
```
This gives you access to a local server at that you can access from your mobile device.
### Android
You need a signing key to make a release build. You can generate it with `keytool`:
```sh
keytool -alias key -genkey -keyalg RSA -keysize 7680 -keystore keystore.pkcs12 -v -validity 36525
```
Move the keystore somewhere safe and create a file `android/key.properties` with the following content:
```properties
keyAlias=key
keyPassword=
storeFile=keystore.pkcs12
storePassword=
```
Don't forget to put the full path and actual passwords in the file. You can find more information about signing keys in .
To make a release build:
```sh
(yes || true) | "$ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager" --install "build-tools;33.0.2" "platforms;android-33"
git clone https://github.com/NatoBoram/Leanish.git
cd Leanish
pnpm install
pnpm run build:apk
pnpm run install:apk
```
This will create a release build at `android/app/build/outputs/apk/release/app-release.apk` and install it on your phone.
## Signatures
Files in the [Releases](https://github.com/NatoBoram/Leanish/releases) tab are signed with a SSH key. You can verify the files' signature with the following commands:
```sh
ssh-keygen -Y verify -f ./.github/authorized_keys -I '41898282+github-actions[bot]@users.noreply.github.com' -n file -s app-release.apk.sig < app-release.apk
ssh-keygen -Y verify -f ./.github/authorized_keys -I '41898282+github-actions[bot]@users.noreply.github.com' -n file -s natoboram-leanish-*.tgz.sig < natoboram-leanish-*.tgz
```
These signatures are only there to indicate that the files were built by GitHub Actions.
## Legal
_Google Play and the Google Play logo are trademarks of Google LLC._