Skip to content

leo-lox/camelus

Repository files navigation

Social Network App Camelus

Screenshot 2024-11-08 202456
Join the social network you control
Download and Install the Android app

Nostr Client for Android

Download on Google Play

1 Introduction

Welcome to our social network app! This mobile application connects users across the globe. The app enables them to share posts and engage with content to interact securely. Unlike traditional networks, this app leverages the Nostr protocol for decentralized data storage. This is enhancing the privacy for users.

Technologies:

  • Frontend: Flutter
  • Backend: Decentralized storage via the Nostr protocol

2 Features

  • Nostr Protocol for Decentralized Data Storage: Ensures user data privacy and control
  • Clean Architecture: Uses Dart and Flutter
  • Dart_NDK Integration: Optimized for mobile battery
  • In-Box and Out-Box Messaging: Optimized for gossip and database performance
  • Open-Source Development: Community-driven project
  • Riverpod for State Management: Efficient and testable state management
1_en-GB 3_en-GB 2_en-GB 4_en-GB 5_en-GB

3 Security

Camelus ensures user privacy by using the Nostr protocol, which stores data in a decentralized way. This means posts, for example, are encrypted to protect user privacy. This decentralized system combined with encryption makes the network secure for sharing posts and any kind of data transactions. This is gives users control over their information.

4 Setting up the project

4.1 Prerequisites

Before you start, make sure that Flutter is installed on your machine. You can check the installation guide and verify the setup at Flutter Installation.

4.2 Clone the Repository

Start by cloning the repository to your local machine:

git clone https://github.com/leo-lox/camelus.git

Clone dart_ndk

Clone the dart_ndk repository into your project directory. Depending on your folder structure, you may need to modify the pubspec.yaml file to point to the correct local path where dart_ndk is located.

Example modification in pubspec.yaml:

dependencies:
  dart_ndk:
    path: ../path/to/dart_ndk

Install Dependencies After ensuring the correct path for dart_ndk, install the dependencies by running:

flutter pub get

run flutter build apk --release or flutter run to run directly on your device in debug mode

5 Download

Android You can join the test and download it from google play link

or use the apk, it is signed with my key so you will need to enable "install from unknown sources" in your phone settings.

6 Conclusion

Camelus is designed to offer secure social networking experience. Users are in control of their data through the Nostr protocol. This application is built with a focus on privacy. Contributions, feedback and ideas from the community are welcome to help shape and improve the app’s future.