Compare commits
1 commit
| Author | SHA1 | Date | |
|---|---|---|---|
| 80a8af1513 |
1 changed files with 33 additions and 155 deletions
188
README.md
188
README.md
|
|
@ -1,175 +1,53 @@
|
|||
|
||||
# Free Competitors
|
||||
|
||||
|
||||
|
||||
|
||||
**Free Competitors** - is a server software to make websites that help users find [Free Software](https://gnu.org) replacements to proprietary software. And search Free Software alternatives to other Free Software.
|
||||
**Free Competitors** is an advanced server software that facilitates the discovery of open-source alternatives to proprietary software, enhancing user sovereignty over software choices. This platform also provides comparisons within the open-source ecosystem itself.
|
||||
|
||||
# Instances
|
||||
## Available Instances
|
||||
|
||||
https://sudo.madiator.com/
|
||||
- **Primary Web Instance**: [Visit Here](https://sudo.madiator.com/)
|
||||
- **Tor Network Instance**: [Access via Tor](https://xhxcyntzwnbkdkpqqjmlsy7kmjgqubgtyghuh5yyd5j4ne54dbgdgkyd.onion/)
|
||||
|
||||
*Tor Instances*
|
||||
## Naming Rationale
|
||||
|
||||
https://xhxcyntzwnbkdkpqqjmlsy7kmjgqubgtyghuh5yyd5j4ne54dbgdgkyd.onion/
|
||||
While the term "Alternative" implies a parity between choices, and "Replacement" suggests a preference, "Competitor" is chosen to denote equality and challenge the norm of proprietary defaults. We encourage community input for more inclusive or accurate terminology.
|
||||
|
||||
## Licensing
|
||||
|
||||
# Name
|
||||
**Free Competitors** is distributed under the AGPLv3 license or later, ensuring all modifications remain free and open. A straightforward mechanism is provided for users to comply with these terms through our source code publication feature. For detailed terms, please refer to the LICENSE file.
|
||||
|
||||
FSF likes the word "Replacement" more then "Alternative" since "Alternative" means that both are equally good. And non-free software is not good. But in my opinion both "Alternative" and "Replacement" tells the user that Non-Free Software is the default option. While I want to shatter this idea a bit by using "Competitor". I think it's the best I can do yet. But perhaps there is a better word. Please tell me if you know one.
|
||||
## Installation and Setup
|
||||
|
||||
# License
|
||||
### Requirements
|
||||
- Python 3.x installed on your server
|
||||
|
||||
This software is under the terms of AGPLv3 or any later version. So imagine GPLv3 or later with one more requirement. You need to publish the source code of the website, if you are hosting it. It has a handy button for source if you change nothing. If you change something, please upload your own version to some place and link to your source instead. Please see LICENSE file for more info.
|
||||
|
||||
# Installation
|
||||
|
||||
The software is built on Python. So you will need to have python3 installed. Then you run the software by doing:
|
||||
|
||||
`python3 server.py`
|
||||
|
||||
On first run, you will be prompted to edit the newly created `config.json`. You should set the URL to be the URL in which you are hosting **Free Competitors** (ex. `http://5wxkwfl6n4abwjsqv5r6roebwbc7fnc22dq3clpooojzdmdnzzo3amad.onion/`). If you do not wish to set a URL, you should set it to `/`. Then, you should specify the port to serve on, and the CSS to use.
|
||||
|
||||
If you want your instance updated with all the new software constantly, please run a script of a similar nature from the same folder:
|
||||
### Installation Steps
|
||||
1. Obtain the latest version:
|
||||
```
|
||||
git clone [repository-url]
|
||||
```
|
||||
2. Enter the project directory:
|
||||
```
|
||||
cd free_competitors
|
||||
```
|
||||
3. Initiate the service:
|
||||
```
|
||||
python3 server.py
|
||||
```
|
||||
Adjust `config.json` as necessary to define the operational parameters of the service.
|
||||
|
||||
### Continuous Integration
|
||||
Maintain your service with our auto-update script, which integrates the latest developments every five minutes:
|
||||
```
|
||||
import time
|
||||
import os
|
||||
while True:
|
||||
time.sleep(300) # Every 5 minutes
|
||||
os.system("git pull") # Pull the changes from git
|
||||
time.sleep(300) # Checks for updates every 300 seconds
|
||||
os.system("git pull") # Updates from the main branch
|
||||
```
|
||||
|
||||
If you want to help us figure out the problems. Like what software are missing and what software has problems in their data. I've made a small checker script [check.py](check.py) that you can use. The output of the script, if it finds anything wrong, will contain a text to copy paste in the Mega-Threads of [Missing Software](https://notabug.org/jyamihud/FreeCompetitors/issues/25) and [Problems with Software](https://notabug.org/jyamihud/FreeCompetitors/issues/24). But please, look into the text yourself first. Perhaps the error is trivial. Or already been posted by someone else. If you can, add the name of your instance.
|
||||
## Get Involved
|
||||
|
||||
Please tell us if you start an instance. We want to add it's link here.
|
||||
|
||||
# How it works?
|
||||
|
||||
In [apps](apps) folder there are a bunch of .json files with different data about various software. When the user types in the name of the software, it looks for a closest match of the name. So the user can slightly misspell the name and it will give him the software. Like somebody can type "What's Up" and get "WhatsApp".
|
||||
|
||||
Next, based on the other data, like features, file formats and supported networks it finds from the list, software that have some or all of the features. And sorts them based on how similar the feature set is.
|
||||
|
||||
The algorithm avoids recommending Non-Free Software. So if you type "WhatsApp" it will recommend you "Element" and other Free Software messengers. But if you write "Element" it will recommend you only Free Software messengers. "WhatsApp" will be excluded. It is done by referencing the "licenses" data-point.
|
||||
|
||||
# API
|
||||
|
||||
When talking to an instance over the normal HTTP insert a `/json/` between the domain name and the search request. So instead of `domainmane.site/youtube` do `domainname.site/json/youtube` and it will give you the same results but formatted as a json.
|
||||
|
||||
# Adding new software
|
||||
|
||||
If your system supports GTK graphical interface software ( most GNU / Linux system are ). You can run the [editor.py](editor.py) program to add and edit the software database. Or you can edit the database manually.
|
||||
|
||||
To add software let's look at two examples from the [apps](apps) folder:
|
||||
|
||||
This is the json for Blender.
|
||||
|
||||
```
|
||||
{"names":["Blender"],
|
||||
"comment":"Blender is a Free Software 3D creation suite. It supports the entirety of the 3D pipeline-modeling, rigging, animation, simulation, rendering, compositing, motion tracking and video editing.",
|
||||
"links":{"website":"https://www.blender.org/",
|
||||
"git":"https://git.blender.org/gitweb/gitweb.cgi/blender.git",
|
||||
"wikipedia":"https://en.wikipedia.org/wiki/Blender_(software)",
|
||||
"documentation":"https://docs.blender.org/manual/en/latest/",
|
||||
"icon":"https://download.blender.org/branding/square/blender_icon_64x64.png"},
|
||||
"licenses":["GPL-2.0-or-later"],
|
||||
"platforms":["GNU/Linux",
|
||||
"Windows",
|
||||
"MacOS",
|
||||
"BSD",
|
||||
"AmigaOS",
|
||||
"Solaris"],
|
||||
"interface":["opengl"],
|
||||
"languages":["C"],
|
||||
"networks_read":[],
|
||||
"networks_write":[],
|
||||
"formats_read":["blend",
|
||||
"dae",
|
||||
"abc",
|
||||
"usd",
|
||||
"usdc",
|
||||
"usda",
|
||||
"svg",
|
||||
"bvh",
|
||||
"ply",
|
||||
"stl",
|
||||
"fbx",
|
||||
"glb",
|
||||
"obj",
|
||||
"x3d",
|
||||
"wrl"],
|
||||
"formats_write":["blend",
|
||||
"dae",
|
||||
"abc",
|
||||
"usd",
|
||||
"usdc",
|
||||
"usda",
|
||||
"svg",
|
||||
"pdf",
|
||||
"obj",
|
||||
"ply",
|
||||
"stl",
|
||||
"fbx",
|
||||
"glb",
|
||||
"gltf",
|
||||
"x3d"],
|
||||
"generic_name":["Text Editor",
|
||||
"Video Editor",
|
||||
"3D Modeling",
|
||||
"3D Rigging",
|
||||
"3D Animation",
|
||||
"3D Rendering",
|
||||
"Compositing",
|
||||
"Motion Tracking"]}
|
||||
```
|
||||
|
||||
Since it's Free Software it's important to give the users links to it's core things. Like the Website where they get a copy and learn more about it. Like the git ( or other version control ) repository of source code. Like the documentation.
|
||||
|
||||
Notice the `icon` datapoint. It links to `download.blender.org`. This way we give away some of the website's load to other websites. Usually Wikipedia has a lot of icons for a lot of software.
|
||||
|
||||
It's also very important to list at least the core file formats / networks that it supports. If you are adding something like Emacs or Gedit which are text editors that can edit text with any extension, please then list the text encoding that it supports. Like `ASCII` or `UTF-8`. Usually they are listed in Save or Open menus.
|
||||
|
||||
The idea here is not to document the software precisely. We are not making a Wikipedia. The idea is to compare features between software to give users a relevant replacement / alternative.
|
||||
|
||||
Also note the `licenses`. You should be careful. In the [data](data) folder there is a licenses list file. We use it to see if the license is Free or not. So please make sure you are using the correct formatting of the license's name. Use `licenseId` preferably.
|
||||
|
||||
Not let's look at a proprietary program YouTube:
|
||||
|
||||
```
|
||||
{"names":["YouTube",
|
||||
"You Tube",
|
||||
"youtube.com",
|
||||
"youtu.be"],
|
||||
"comment":"A platform for uploading and watching videos.",
|
||||
"links":{"website":"https://youtube.com",
|
||||
"wikipedia":"https://en.wikipedia.org/wiki/YouTube",
|
||||
"icon":"https://upload.wikimedia.org/wikipedia/commons/thumb/0/09/YouTube_full-color_icon_%282017%29.svg/120px-YouTube_full-color_icon_%282017%29.svg.png"},
|
||||
"platforms":["Android",
|
||||
"iOS",
|
||||
"Web"],
|
||||
"interface":["HTML5"],
|
||||
"languages":["JavaScript"],
|
||||
"networks_read":["youtube"],
|
||||
"networks_write":["youtube"],
|
||||
"formats_read":[],
|
||||
"formats_write":[],
|
||||
"generic_name":["Video Player",
|
||||
"YouTube Client",
|
||||
"Music Player",
|
||||
"Publication"],
|
||||
"issues":["Surveillance",
|
||||
"Non-Free Software",
|
||||
"Non-Free JavaScript",
|
||||
"DRM"]}
|
||||
```
|
||||
|
||||
With surveillance software we try to avoid linking it's icon from the website itself. It should not even try to connect to the bad website. We don't know what they are doing with the server logs. So here it's very important to use Wikipedia. Alternatively you can host the logo yourself somewhere. Perhaps on LBRY. And use a spee.ch link to it.
|
||||
|
||||
Also notice the additional `issues` datapoint. It's important to have a list of Anti-Features. Try looking at F-droid.org for inspiration of this. Telegram, by the way, has Anti-Features even though it's Free Software. So we list them.
|
||||
|
||||
Again, remember, we are looking for similarities of data. Not documenting everything. Things like `generic_name` plays a big role in finding the replacements / alternatives. File formats and networks play a bit role too. If in `photoshop.json` it will have a generic name "Image Editor" and in `gimp.json` it will have "Editor of Images" it will fail to find the match. So please study the files before adding a new one.
|
||||
|
||||
It is quite important to fill as much as possible data about Non-Free Software too. Even though the data will never be shown to the user. Because we want to compare the features and the formats to find Competitors. And later other functions may be added that use such a data.
|
||||
|
||||
# Contact info
|
||||
|
||||
We hang out on [matrix] in `#freecompetitors:matrix.org`
|
||||
Contributions to **Free Competitors** are highly valued. For those looking to contribute code, report bugs, or suggest features, please visit our GitHub issues page. Alternatively, engage with our developers directly on [Matrix](https://matrix.org) at `#freecompetitors:matrix.org`.
|
||||
|
|
|
|||
Loading…
Reference in a new issue