2
0
mirror of https://github.com/ComradCollective/Comrad synced 2024-11-01 21:40:32 +00:00
Comrad/README.md

121 lines
4.3 KiB
Markdown
Raw Normal View History

2020-08-06 10:39:56 +00:00
# Komrade
2020-08-05 09:15:10 +00:00
2020-08-13 18:16:10 +00:00
Komrade is a socialist network. It is predicated on anti-capitalist and anti-racist principles of community and solidarity.
2020-08-05 09:15:10 +00:00
2020-08-06 11:17:13 +00:00
## Why another social network?
2020-08-13 18:34:03 +00:00
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.
2020-08-06 11:17:13 +00:00
2020-08-05 09:15:10 +00:00
## Features
### Your traffic is untraceable
2020-08-06 11:13:03 +00:00
All traffic is routed via [Tor](https://www.torproject.org/), a global maze of computers so dense that even the FBI can't trace your footsteps. And 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.
2020-08-05 09:15:10 +00:00
### Be as anonymous as you wish
Design a profile and account which is as anonymous as you want to make it. If you don't reveal yourself, your traffic or behavior elsewhere on the internet won't either.
### Best of what's out there
We present a simplified set of social media features drawn from everything that's out there and then some:
* Profile
* 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)
2020-08-12 19:53:59 +00:00
* Posting
* Post up to 1 image and/or 1000 characters
2020-08-05 09:15:10 +00:00
* 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)
2020-08-06 11:22:53 +00:00
* Post anonymously or from your account (new)
2020-08-05 09:15:10 +00:00
* Organizing
* Host events and invite others (e.g. Facebook)
2020-08-06 11:22:53 +00:00
* Host events like protests anonymously (new)
2020-08-05 09:59:15 +00:00
* Anonymously pin on a map sites of danger, like police (e.g. Waze)
2020-08-05 09:15:10 +00:00
* Messaging
* Message securely with encrypted contents (e.g. Signal)
2020-08-06 11:22:53 +00:00
* Message securely with untraceable metadata (new)
2020-08-05 09:15:10 +00:00
### Open-source and community run
2020-08-05 09:19:38 +00:00
Not just non-profit, we're anti-profit.
2020-08-06 13:02:26 +00:00
## Progress
### Screens
2020-08-09 10:33:35 +00:00
#### Preview animation
2020-08-13 17:41:59 +00:00
<img src="client/assets/komrade-peek-2.gif" height="600" alt="GIF animation" />
2020-08-09 10:33:35 +00:00
2020-08-06 13:02:26 +00:00
#### Login screen
Got this working on front and backend.
2020-08-06 13:06:36 +00:00
<img src="client/assets/screen-login.png" height="600" alt="Login screen" />
2020-08-06 13:02:26 +00:00
#### Post
2020-08-09 10:39:11 +00:00
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?
2020-08-06 13:02:26 +00:00
2020-08-09 10:33:35 +00:00
<img src="client/assets/screen-feed.png" height="600" alt="Post screen" />
2020-08-06 13:02:26 +00:00
## Technical details
2020-08-05 09:19:38 +00:00
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
2020-08-12 07:55:06 +00:00
The server also runs on Python, serving a graph database powered by [Neo4j](https://neo4j.com/).
## Install
### As developer
2020-08-12 07:58:21 +00:00
The usual installation:
2020-08-12 07:55:06 +00:00
```
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
```
2020-08-12 08:13:00 +00:00
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.
2020-08-12 07:55:06 +00:00
### As user
2020-08-12 07:57:06 +00:00
Coming soon.