selfprivacy.org.app/README.md

# SelfPrivacy App

SelfPrivacy — is a platform on your cloud hosting, that allows to deploy your own private services and control them using mobile application.

To use this application, you'll be required to create accounts of different service providers. Please reffer to this manual: https://selfprivacy.org/docs/getting-started/

Application will do the following things for you:

1. Create your personal server
2. Setup NixOS
3. Bring all services to the ready-to-use state. Services include:

* E-mail, ready to use with DeltaChat
* NextCloud - your personal cloud storage
* Bitwarden — secure and private password manager
* Pleroma — your private fediverse space for blogging
* Jitsi — awesome Zoom alternative
* Gitea — your own Git server
* OpenConnect — Personal VPN server

**Project is currently in open beta state**. Feel free to try it. It would be much appreciated if you would provide us with some feedback. 

## Building

Supported platforms are Android, Linux, and Windows. We are looking forward to support iOS and macOS builds.

For Linux builds, make sure you have these packages installed:
|Arch-based|Debian-based|
|----------|------------|
|pacman -S ninja xdg-user-dirs gnome-keyring unzip xz-utils zip|apt install ninja-build xdg-user-dirs gnome-keyring unzip xz-utils zip|

Install [Flutter](https://docs.flutter.dev/get-started/install/linux) and [Android SDK tools](https://developer.android.com/studio/command-line/sdkmanager), then try your setup:

```
flutter pub get

# Build .APK for Android
flutter build --flavor production apk
# Build AAB bundle for Google Play
flutter build --flavor production aab
# Build Linux binaries
flutter build linux
# Build Windows binaries
flutter build windows

# Package AppImage
appimage-builder --recipe appimage.yml
# Package Flatpak
flatpak-builder --force-clean --repo=flatpak-repo flatpak-build flatpak.yml
flatpak build-bundle flatpak-repo org.selfprivacy.app.flatpak org.selfprivacy.app
```

## Translations

[![Translation status](http://weblate.selfprivacy.org/widgets/selfprivacy/-/selfprivacy-app/multi-auto.svg)](http://weblate.selfprivacy.org/engage/selfprivacy/)

Translations are stored in `assets/translations/*.json` and can be edited on <https://weblate.selfprivacy.org/projects/selfprivacy/selfprivacy-app/>.
Fix links 2021-10-26 14:57:06 +00:00			`# SelfPrivacy App`
add navigation 2020-11-29 20:07:46 +00:00
fix metadata and add README 2022-09-29 09:08:04 +00:00			`SelfPrivacy — is a platform on your cloud hosting, that allows to deploy your own private services and control them using mobile application.`
add navigation 2020-11-29 20:07:46 +00:00
fix old link 2023-05-19 08:45:22 +00:00			`To use this application, you'll be required to create accounts of different service providers. Please reffer to this manual: https://selfprivacy.org/docs/getting-started/`
add navigation 2020-11-29 20:07:46 +00:00
fix metadata and add README 2022-09-29 09:08:04 +00:00			`Application will do the following things for you:`
add navigation 2020-11-29 20:07:46 +00:00
fix metadata and add README 2022-09-29 09:08:04 +00:00			`1. Create your personal server`
			`2. Setup NixOS`
			`3. Bring all services to the ready-to-use state. Services include:`
add navigation 2020-11-29 20:07:46 +00:00
fix metadata and add README 2022-09-29 09:08:04 +00:00			`* E-mail, ready to use with DeltaChat`
			`* NextCloud - your personal cloud storage`
			`* Bitwarden — secure and private password manager`
			`* Pleroma — your private fediverse space for blogging`
			`* Jitsi — awesome Zoom alternative`
			`* Gitea — your own Git server`
			`* OpenConnect — Personal VPN server`
add navigation 2020-11-29 20:07:46 +00:00
fix metadata and add README 2022-09-29 09:08:04 +00:00			`Project is currently in open beta state. Feel free to try it. It would be much appreciated if you would provide us with some feedback.`

			`## Building`

			`Supported platforms are Android, Linux, and Windows. We are looking forward to support iOS and macOS builds.`

docs: Add brief list of critical packages for Linux build Since I always forget what implicit dependencies this application has, maybe we need better documentation structure 2022-11-02 20:50:36 +00:00			`For Linux builds, make sure you have these packages installed:`
			`\|Arch-based\|Debian-based\|`
			`\|----------\|------------\|`
			`\|pacman -S ninja xdg-user-dirs gnome-keyring unzip xz-utils zip\|apt install ninja-build xdg-user-dirs gnome-keyring unzip xz-utils zip\|`

			`Install [Flutter](https://docs.flutter.dev/get-started/install/linux) and [Android SDK tools](https://developer.android.com/studio/command-line/sdkmanager), then try your setup:`

fix metadata and add README 2022-09-29 09:08:04 +00:00			```
			`flutter pub get`

			`# Build .APK for Android`
			`flutter build --flavor production apk`
			`# Build AAB bundle for Google Play`
			`flutter build --flavor production aab`
			`# Build Linux binaries`
			`flutter build linux`
			`# Build Windows binaries`
			`flutter build windows`

			`# Package AppImage`
			`appimage-builder --recipe appimage.yml`
			`# Package Flatpak`
			`flatpak-builder --force-clean --repo=flatpak-repo flatpak-build flatpak.yml`
			`flatpak build-bundle flatpak-repo org.selfprivacy.app.flatpak org.selfprivacy.app`
			```

			`## Translations`

chore(i18l): Add all plurals to en locale Also add translation status to README 2022-10-04 13:45:39 +00:00			`[![Translation status](http://weblate.selfprivacy.org/widgets/selfprivacy/-/selfprivacy-app/multi-auto.svg)](http://weblate.selfprivacy.org/engage/selfprivacy/)`

fix metadata and add README 2022-09-29 09:08:04 +00:00			Translations are stored in `assets/translations/*.json` and can be edited on <https://weblate.selfprivacy.org/projects/selfprivacy/selfprivacy-app/>.