https://github.com/torx-chat/torx-flutter

Flutter client implementing the TorX Library
https://github.com/torx-chat/torx-flutter

android anonymity apk chat-application flutter ios security tor

Last synced: about 2 months ago
JSON representation

Flutter client implementing the TorX Library

• Host: GitHub
• URL: https://github.com/torx-chat/torx-flutter
• Owner: TorX-Chat
• License: gpl-3.0
• Created: 2024-05-29T07:00:07.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-11-11T21:00:52.000Z (about 2 months ago)
• Last Synced: 2024-11-11T22:17:59.274Z (about 2 months ago)
• Topics: android, anonymity, apk, chat-application, flutter, ios, security, tor
• Language: Dart
• Homepage: https://TorX.Chat
• Size: 496 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


### TorX Flutter Client (torx-flutter)

This page is primarily for developers and contributors.


If you are simply looking to download and run TorX, go to [Download](https://torx.chat/#download)


If you want to contribute, see [Contribute](https://torx.chat/#contribute) and our [TODO Lists](https://torx.chat/todo.html)

#### Build Instructions:

###### Step 1: Create a new project (NOTE: This may be used to get the android/build.gradle file, which may be necessary to build and run if we haven't run in a while and we're getting 404 errors on .pom files)

```

flutter create --org com.torx --project-name chat --description "A chat software" --platforms android bare

cd bare && rm -r test && flutter pub global activate rename && flutter pub global run rename setAppName --targets android --value "TorX" && cd ..

git clone https://github.com/TorX-Chat/torx-flutter

cp -Rn bare/* torx-flutter

cd torx-flutter

```

###### Step 2: First build / Build from scratch (takes several minutes) (WARNING: will delete libtor.so, libsnowflake.so, etc)

```

rm -rf build/ android/app/.cxx/Debug/ android/app/.cxx/RelWithDebInfo

rm android/app/src/main/jniLibs/*/*.so

flutter pub run flutter_launcher_icons

flutter run

```

###### Subsequent builds (takes 10-20 seconds, including fresh builds of libtorx)

`flutter run`

###### For building a release (Remember to increase the version in pubspec.yaml or F-Droid will ignore the update.)

`flutter build apk`

#### Voluntary Contribution Licensing Agreement:

Subject to implicit consent: Ownership of all ideas, suggestions, issues, pull requests, contributions of any kind, etc, are non-exclusively gifted to the original TorX developer without condition nor consideration, for the purpose of improving the software, for the benefit of all users, current and future. Any contributor who chooses not to apply this licensing agreement may make an opt-out statement when making their contribution.

Note: The purpose of this statement is so that TorX can one day be re-licensed as GPLv2, GPLv4, AGPL, MIT, BSD, CC0, etc, in the future, if necessary. If you opt-out, your contributions will need to be stripped if we one day need to re-license and we're unable to contact you for your explicit consent. You may opt-out, but please don't.

#### Screenshots: