You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Comrad/README.md

128 lines
4.6 KiB
Markdown

4 years ago
# Komrade
4 years ago
4 years ago
Komrade is a socialist network. It is predicated on anti-capitalist and anti-racist principles of community and solidarity.
4 years ago
4 years ago
## Why another social network?
4 years ago
Is a 'socialist network' possible? Although the internet began with anarchic design principles, it quickly consolidated into the hands of a few of the largest corporations in the world. It has effectively recreated the capitalist mode of production within itself: the *means* of content production (social media platforms) are privatized while the *labor* of production (posting) remains socially distributed. Exploitation inheres in that relation, whether in the industrial factory or the digital platform.
But the digital platform can be redesigned. The technology behind these social media platforms is actually quite simple. We can easily build our own social network, one which is secure, insurveillable, and unmonetizable—one which would give people the security they need to communicate about whatever they want, including protesting against capital and the state.
4 years ago
4 years ago
## Principles
4 years ago
4 years ago
### Encrypted
4 years ago
4 years ago
All of your data is strongly encrypted, and only you and those you choose will be able to decrypt and read it. To anyone without the right decryption 'key', the data is nonsense.
4 years ago
4 years ago
### Decentralized
4 years ago
4 years ago
Komrade doesn't live on a server, but rather in the ether between all the devices curently running Komrade. Rather than the hierarchical server/client relationship, which exposes the entire network to attacks on a central server, Komrade uses peer-to-peer networking to store its data and communicate across the network.
### Untraceable
All traffic is routed via [I2P](https://geti2p.net/en/), an anonymous global maze of computers so dense that even the FBI can't trace your footsteps.
### Unmonetizable
What's untraceable is also unmonetizable: your data can't be harvested by technology companies and used for advertising algorithms. You're protected from both surveillance capitalism and the surveillance state.
4 years ago
4 years ago
### Open-source
Not just non-profit, we're anti-profit.
## Features
4 years ago
We present a simplified set of social media features drawn from everything that's out there and then some:
4 years ago
### Profile
4 years ago
* Curate a profile with photo and posts (e.g. Twitter)
* Show profile to world (e.g. Twitter)
* Show profile only to friends (e.g. Facebook)
* Show profile only to your local area (e.g. Nextdoor)
4 years ago
### Posting
* Post up to 1 image and/or 1000 characters
4 years ago
* Post to the entire world (e.g. Twitter)
* Post to your friends (e.g. Facebook)
* Post to your surrounding area by a distance radius (e.g. Nextdoor)
* Anonymously up-vote or down-vote posts (e.g. Reddit)
4 years ago
* Post anonymously or from your account (new)
4 years ago
4 years ago
### Organizing
4 years ago
* Host events and invite others (e.g. Facebook)
4 years ago
* Host events like protests anonymously (new)
4 years ago
* Anonymously pin on a map sites of danger, like police (e.g. Waze)
4 years ago
4 years ago
### Messaging
4 years ago
* Message securely with encrypted contents (e.g. Signal)
4 years ago
* Message securely with untraceable metadata (new)
4 years ago
## Progress
### Screens
4 years ago
#### Preview animation
4 years ago
<img src="client/assets/komrade-peek-2.gif" height="600" alt="GIF animation" />
4 years ago
#### Login screen
Got this working on front and backend.
4 years ago
<img src="client/assets/screen-login.png" height="600" alt="Login screen" />
#### Post
4 years ago
Experimenting with posts as 'cards', kind of like Tinder, which you can swipe up to up-vote or amplify, swipe down to down-vote or dampen, swipe left to see the next card and swipe right to see the previous. A horizontal feed basically. One image or video allowed; up to 1000? words allowed; maybe a title?
4 years ago
<img src="client/assets/screen-feed.png" height="600" alt="Post screen" />
## Technical details
4 years ago
Design details are changing rapidly, but these are what we have so far.
### App
The 'client' or app is made with [KivyMD](https://github.com/kivymd/KivyMD), a variant of [Kivy](https://kivy.org/), a cross-platform mobile development framework in Python. Python is an easy and versatile progamming language to learn, which keeps the code accessible to as many people as possible.
### Server
4 years ago
The server also runs on Python, serving a graph database powered by [Neo4j](https://neo4j.com/).
## Install
### As developer
4 years ago
The usual installation:
4 years ago
```
git clone https://github.com/quadrismegistus/Komrade.git
cd Komrade
pip install -r requirements.txt
```
Then run the client:
```
cd client
./run.sh
```
This is configured to use my server. Optionally, you can run your own server:
```
cd server
./run.sh
```
Change the SERVER_ADDR constant at the top of client/main.py to point to your server. You will need neo4j installed. You will also need to change the neo4j login configuration at the top of server/models.py.
4 years ago
### As user
4 years ago
Coming soon.