Files
Repo/README.md
2025-04-29 17:14:32 +02:00

89 lines
1.8 KiB
Markdown

# 📁 FeloStore Repo
**FeloStore Repo** is a self-hosted [F-Droid](https://f-droid.org) repository designed to serve APKs collected by the [FeloStore Scraper](https://github.com/YOUR_USERNAME/FeloStore-Scraper). This repository enables users to browse, install, and update apps via the F-Droid client.
---
## 🚀 Features
- Host your own F-Droid-compatible app repository
- Seamless integration with the FeloStore Scraper
- Automated updates via a helper script
---
## 🛠️ Setup Instructions
### 1. Install `fdroidserver` with `pipx` (Recommended)
Ensure you're on a **Debian-based** system and have Python + `pipx` installed.
```bash
# Install pipx if not already available
sudo apt update
sudo apt install pipx python3-venv -y
# Ensure pipx is in your PATH
pipx ensurepath
# Restart your shell or run the next command in a new session
# Install fdroidserver using pipx
pipx install fdroidserver
```
---
### 2. Clone the Repository
```bash
git clone https://github.com/YOUR_USERNAME/FeloStore-Repo.git
cd FeloStore-Repo
```
---
### 3. Initialize the F-Droid Repo (First Time Only)
> ⚠️ Only run this step if you're setting up the repo from scratch.
```bash
fdroid init
```
---
### 4. Use the `update.sh` Script
The `update.sh` script in the root of this repository is used to:
- Scan the `repo/` folder for new APKs
- Update the `index.xml` used by F-Droid clients
- Sign and publish the repository metadata
#### Run it manually:
```bash
./update.sh
```
#### Or automate it with cron:
```bash
crontab -e
# Example: run every hour
0 * * * * /path/to/your/FeloStore-Repo/update.sh
```
---
## 🤝 Contributing
Feel free to fork this repo, suggest improvements, or open pull requests!
---
## 📜 License
This project is licensed under the [MIT License](LICENSE).