Merge pull request 'Chore: Fix Metadata and Add README' (#122) from metadata into master
Reviewed-on: kherel/selfprivacy.org.app#122 Reviewed-by: Inex Code <inex.code@selfprivacy.org>pull/126/head
commit
fecf96f31e
51
README.md
51
README.md
|
|
@ -1,17 +1,48 @@
|
|||
# SelfPrivacy App
|
||||
|
||||
- [Official site](https://selfprivacy.org)
|
||||
- [SelfPrivacy App (F-Droid)](https://f-droid.org/en/packages/pro.kherel.selfprivacy/)
|
||||
SelfPrivacy — is a platform on your cloud hosting, that allows to deploy your own private services and control them using mobile application.
|
||||
|
||||
## Getting Started
|
||||
To use this application, you'll be required to create accounts of different service providers. Please reffer to this manual: https://selfprivacy.org/en/second
|
||||
|
||||
This project is a starting point for a Flutter application.
|
||||
Application will do the following things for you:
|
||||
|
||||
A few resources to get you started if this is your first Flutter project:
|
||||
1. Create your personal server
|
||||
2. Setup NixOS
|
||||
3. Bring all services to the ready-to-use state. Services include:
|
||||
|
||||
- [Lab: Write your first Flutter app](https://flutter.dev/docs/get-started/codelab)
|
||||
- [Cookbook: Useful Flutter samples](https://flutter.dev/docs/cookbook)
|
||||
* 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
|
||||
|
||||
For help getting started with Flutter, view our
|
||||
[online documentation](https://flutter.dev/docs), which offers tutorials,
|
||||
samples, guidance on mobile development, and a full API reference.
|
||||
**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.
|
||||
|
||||
```
|
||||
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
|
||||
|
||||
Translations are stored in `assets/translations/*.json` and can be edited on <https://weblate.selfprivacy.org/projects/selfprivacy/selfprivacy-app/>.
|
||||
|
|
|
|||
|
|
@ -1,15 +1,23 @@
|
|||
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/en/second.html
|
||||
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
|
||||
<p>SelfPrivacy — is a platform on your cloud hosting, that allows to deploy your own private services and control them using mobile application.</p>
|
||||
|
||||
!!! 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.
|
||||
<p>To use this application, you'll be required to create accounts of different service providers. Please reffer to this manual: https://selfprivacy.org/en/second</p>
|
||||
|
||||
<p>Application will do the following things for you:</p>
|
||||
|
||||
<ol>
|
||||
<li>Create your personal server</li>
|
||||
<li>Setup NixOS</li>
|
||||
<li>Bring all services to the ready-to-use state. Services include:</li>
|
||||
</ol>
|
||||
|
||||
<ul>
|
||||
<li>E-mail, ready to use with DeltaChat</li>
|
||||
<li>NextCloud — your personal cloud storage</li>
|
||||
<li>Bitwarden — secure and private password manager</li>
|
||||
<li>Pleroma — your private fediverse space for blogging</li>
|
||||
<li>Jitsi — awesome Zoom alternative</li>
|
||||
<li>Gitea — your own Git server</li>
|
||||
<li>OpenConnect — Personal VPN server</li>
|
||||
</ul>
|
||||
|
||||
<p><b>Project is currently in open beta state</b>. Feel free to try it. It would be much appreciated if you would provide us with some feedback.</p>
|
||||
|
|
|
|||
Loading…
Reference in New Issue