Skip to content

Latest commit

 

History

History
207 lines (167 loc) · 8.05 KB

README.md

File metadata and controls

207 lines (167 loc) · 8.05 KB

Banner

An open-source, lightweight and privacy-focused BeReal alternative client.

Build Badge License Badge

📥 Download




Windows


macOS


Linux
x86_64 : ↗ MSI, ↗ NSIS
aarch64 : ↗ NSIS
aarch64 : ↗ DMG
x86_64 : ↗ DMG



Android (.apk)


iOS (.ipa)
iOS is currently not supported, the internal API needs an implementation in Swift.

✨ Features

  • Authentication
    • Accounts with parental control are not supported, if you have one, please open an issue so we can work on it.
  • My Profile
    • Informations
    • Realmojis
    • Memories
    • Pinned
  • User Profile
  • Feed
    • My posts
    • Comments on my posts
    • Swipper for my posts
    • Users
    • Posts
    • Swipper for multiple posts
    • Comments
    • Reactions
  • Post a BeReal
  • Comment under a post
  • React to a post with your realmojis
  • Accept a friend request
  • Friends recommendations
  • Listing of friends
  • Notifications
  • Settings
    • Update region for moments

Advanced

Some advanced features that are not in the original application.

  • Light mode
  • Upload from gallery (not only camera)
  • Manual camera (there is no delay between primary image and secondary image)
  • Cache data to device local database (for faster reloading and offline access)

Privacy

Only the necessary data is stored on the device, and the application does not collect any personal information.

  • No tracking
  • No analytics
  • No ads

FAQ

Why is there a permanent notification on Android?

The notification is used to keep the notification service running in the background, so you can receive notifications even when the application is closed.

This is a limitation of the Android operating system, and I don't know any way to make this better. If you have any idea, please open an issue or even better, a pull request.

Note that you can hide this specific notification called BeReal Moments (Service) in the Android settings, but there's a chance that the service will be killed and you will receive no more notification.

Why is the application not available on the Google Play Store?

The application is not available on the Google Play Store because it does not respect the terms of service of the platform. The application is not malicious, but it does not respect the terms of service because it is a third-party client.

🛠️ Development

Prerequisites

Follow the instructions on the ↗ Tauri documentation to setup your environment depending on your operating system and target platform.

Also, make sure you have ↗ pnpm installed since it's the package manager used in this project.

Quick start

git clone https://github.com/Vexcited/StayReal && cd StayReal

# Install dependencies
pnpm install

# Build internal-api
cd internal-api 
pnpm install
pnpm build
cd ..

# Start development on desktop
pnpm tauri dev

# Start development on Android
pnpm tauri android dev

Build for release

# Build for desktop
pnpm tauri build

# Build for Android
pnpm tauri android build

If you want to know more about the pipeline used to build the application, you can check the ↗ GitHub Actions workflow.

🙏 Acknowledgments

A lot of similar projects and researches have been made, and we would like to thank the authors for their work.

📄 License

StayReal is licensed under the ↗ GNU General Public License v3.0 (GPL-3.0), a copyleft license that ensures users’ freedom to run, study, share, and modify the software. Licensed works, modifications, and larger works must also be distributed under GPL-3.0, and source code must be provided or made available.