FreeCompetitors/README.md

54 lines
2.1 KiB
Markdown
Raw Permalink Normal View History

2024-04-29 18:41:37 +02:00
# Free Competitors
2024-04-29 18:41:37 +02:00
![Free Competitors Interface](screen_shot_01.png)
2022-04-02 14:01:02 +02:00
2024-04-29 18:41:37 +02:00
**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.
2022-04-02 14:01:02 +02:00
2024-04-29 18:41:37 +02:00
## Available Instances
2022-04-01 11:46:07 +02:00
2024-04-29 18:41:37 +02:00
- **Primary Web Instance**: [Visit Here](https://sudo.madiator.com/)
- **Tor Network Instance**: [Access via Tor](https://xhxcyntzwnbkdkpqqjmlsy7kmjgqubgtyghuh5yyd5j4ne54dbgdgkyd.onion/)
2022-04-01 11:46:07 +02:00
2024-04-29 18:41:37 +02:00
## Naming Rationale
2022-04-01 11:46:07 +02:00
2024-04-29 18:41:37 +02:00
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.
2022-04-01 11:46:07 +02:00
2024-04-29 18:41:37 +02:00
## Licensing
2022-04-01 11:46:07 +02:00
2024-04-29 18:41:37 +02:00
**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.
2022-04-01 11:46:07 +02:00
2024-04-29 18:41:37 +02:00
## Installation and Setup
2022-04-01 11:46:07 +02:00
2024-04-29 18:41:37 +02:00
### Requirements
- Python 3.x installed on your server
2022-04-01 11:46:07 +02:00
2024-04-29 18:41:37 +02:00
### 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.
2022-04-05 20:21:04 +02:00
2024-04-29 18:41:37 +02:00
### Continuous Integration
Maintain your service with our auto-update script, which integrates the latest developments every five minutes:
2022-04-05 20:21:04 +02:00
```
import time
import os
while True:
2024-04-29 18:41:37 +02:00
time.sleep(300) # Checks for updates every 300 seconds
os.system("git pull") # Updates from the main branch
2022-04-02 10:28:46 +02:00
```
2022-04-01 11:46:07 +02:00
2024-04-29 18:41:37 +02:00
## Get Involved
2022-04-01 11:46:07 +02:00
2024-04-29 18:41:37 +02:00
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`.