Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/upryzing/clerotri
React Native client for Upryzing and Revolt. Community-led project.
https://github.com/upryzing/clerotri
clerotri react-native revolt revolt-client rvmob upryzing upryzing-client
Last synced: about 14 hours ago
JSON representation
React Native client for Upryzing and Revolt. Community-led project.
- Host: GitHub
- URL: https://github.com/upryzing/clerotri
- Owner: upryzing
- License: agpl-3.0
- Created: 2021-10-22T23:37:12.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-19T11:46:50.000Z (about 23 hours ago)
- Last Synced: 2025-01-19T12:45:15.388Z (about 22 hours ago)
- Topics: clerotri, react-native, revolt, revolt-client, rvmob, upryzing, upryzing-client
- Language: TypeScript
- Homepage: https://rvlt.gg/rvmob
- Size: 8.94 MB
- Stars: 129
- Watchers: 6
- Forks: 21
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Clerotri
**Clerotri** is a Revolt client made with React Native. It is currently available for Android and will be available for web in the future.
**Please note that Clerotri is currently in beta.** It contains several bugs and incomplete features - use at your own discretion.
For development updates and other news, join [Clerotri's support server][support-server].
## Installing
If you want to install Clerotri for Android, simply go to [the releases tab](https://github.com/upryzing/clerotri/releases) and download the latest version. We plan on publishing Clerotri to app stores in the future.
Debug builds are also produced for every commit. These are unoptimised - they're much larger and noticeably slower than the release builds, but you can try out new features early.
### Info about split builds
Also note that, from v0.7.0, Clerotri's APKs are **split by architecture**. This helps to reduce file and app sizes - however, you'll need to make sure that you **download the APK that matches your device's architecture**, or **it won't install!**
**If you're using an app store, this should be handled for you.**
If not, however, you'll need to check your device's architecture. I'd recommend using [Treble Info](https://gitlab.com/TrebleInfo/TrebleInfo/-/blob/dev/README.md) for this.
Install and open the app - **don't worry about what it says on the home page!** - then open the Details tab and check the CPU architecture entry. Depending on what it says:
- if it says `ARM64`, you'll want the APK with **`arm64-v8a`** in its file name;
- if it says `ARM32`, you'll want the APK with **`armeabi-v7a`** in its file name;
- if it says `x86_64`, you'll want the APK with **`x86_64`** in its file name;
- and if it says `x86`, you'll want the APK with **`x86` but without `64`** in its file name.
If it says `Unknown`, please ask for help in [our support server][support-server].
## Building
If you want to build Clerotri for web, you'll need:
- [Node](https://nodejs.org/en/) (v18+) and
- [Yarn Classic](https://classic.yarnpkg.com).
If you want to build Clerotri for Android, you'll also need:
- JDK 17 ([Microsoft's build](https://learn.microsoft.com/en-gb/java/openjdk/download) works well) and
- the latest Android SDK (preferably via [Android Studio](https://developer.android.com/studio)'s SDK Manager).
Then run the following:
```sh
yarn install
npx react-native-asset
# for web:
yarn web
# for android:
yarn android
yarn start # if metro doesn't start
```
CLI commands:
| Command | Description |
| -------------- | ----------------------------------------- |
| `yarn start` | Starts Metro (the dev server). |
| `yarn test` | Tests to see if everything is working. |
| `yarn web` | Runs the web app. |
| `yarn android` | Runs the Android app. |
| `yarn ios` | Runs the iOS app (broken/requires a Mac). |
| `yarn lint` | Checks the code syntax using ESLint. |
For more information, see a list of `react-native`'s commands [here](https://github.com/react-native-community/cli/blob/master/docs/commands.md). You can access them by running `yarn react-native`.
## Troubleshooting
If you encounter bugs, first check if you're able to [open Revolt in your browser](https://app.revolt.chat); also, check if you have any firewall settings that may block the Revolt API.
If you're still experiencing issues, and there aren't any open issues for the bug(s) you're facing, please [open an issue](https://github.com/upryzing/clerotri/issues).
## License
Clerotri is licensed under the [GNU Affero General Public License v3.0](https://github.com/upryzing/clerotri/blob/main/LICENSE).
[support-server]: https://rvlt.gg/rvmob