kuba/fm-dx-webserver
1
0
Fork 0
mirror of https://github.com/KubaPro010/fm-dx-webserver.git synced 2026-02-26 22:13:53 +01:00
Code Issues Activity

fix: update readme.md

Browse Source
This commit is contained in:
Mark de Bruijn
2025-09-26 08:12:30 +02:00
parent d6b563456f
commit 2ffaad16ac
1 changed files with 32 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

76
README.md
View File

@@ -2,62 +2,50 @@
FM-DX Webserver is a cross-platform web server designed for FM DXers who want to control their radio receiver through a web interface. FM-DX Webserver is a cross-platform web server designed for FM DXers who want to control their radio receiver through a web interface.
# Officially supported devices ## Supported devices
- **TEF668x:** Supported with PE5PVB's and Konrad's FM-DX Tuner firmware, although Arduino versions with other firmwares will work too
- **XDR F1HD:** Officially supported, works best with Konrad's FM-DX Tuner firmware - **TEF668x:** Supported with PE5PVB's and Konrad's FM-DX Tuner firmware, Arduino versions with other firmwares should work too.
- **SDR (AirSpy / RTL-SDR):** Supported unofficially via SDRSharp and the XDR-GTK plugin - **XDR F1HD:** Officially supported, works best with Konrad's FM-DX Tuner firmware.
- **SDR (AirSpy / RTL-SDR):** Supported **unofficially** via SDRSharp and the XDR-GTK plugin.
## Features ## Features
- **Web-Based Control:** Access and control your TEF6686 / F1HD receiver from any device with a web browser.
- **Cross-platform support:**
- Linux
- macOS
- Windows
- **Web-Based Control:** Access and control your receiver from any device with a web browser.
- **Low-latency streaming**: Built in directly into the webserver, no external apps needed for users.
- **Plugin-support**: See our wiki for summary of available [plugins](https://github.com/NoobishSVK/fm-dx-webserver/wiki/Plugin-List).
- **FM DXing:** Enhance your FM/AM DXing experience with a user-friendly web interface. - **FM DXing:** Enhance your FM/AM DXing experience with a user-friendly web interface.
- **Cross-Platform:** You can run this on both Windows and Linux servers along with xdrd.
- **Low-latency streaming**: Built in directly into the webserver, no external apps needed for users
## Features to be added ## Getting Started
Check [here](https://trello.com/b/OAKo7n0Q/fm-dx-webserver) for an up to date task list
## Community - [Linux installation](https://github.com/NoobishSVK/fm-dx-webserver/wiki/Linux-Installation)
Join our **Discord community** to get the latest development update info, share feedback and receive support. - [macOS installation](https://github.com/NoobishSVK/fm-dx-webserver/wiki/macOS-Installation)
[<img alt="Join the OpenRadio Discord community!" src="https://i.imgur.com/lI9Tuxf.png" height="120">](https://discord.gg/ZAVNdS74mC) - [Windows installation](https://github.com/NoobishSVK/fm-dx-webserver/wiki/Windows-Installation)
## Getting Started (Windows)
1. Install node.js from here:
```bash
https://nodejs.org/en
```
2. Clone the repository (or alternatively download it manually):
```bash
git clone https://github.com/NoobishSVK/FM-DX-Webserver.git
```
3. Navigate to the fm-dx-webserver folder in your terminal/command prompt and run this command:
```bash
npm install
```
4. Start the server:
```bash
npm run webserver
```
5. Open your web browser and navigate to `http:/localhost:8080` to access the web interface.
## Getting Started (Linux)
[Click here for the Linux installation tutorial.](https://gist.github.com/bkram/788098558312d2fa71c07dc443e03d10)
## Utilized projects ## Utilized projects
This project utilizes these libraries: This project utilizes these libraries:
- [librdsparser](https://github.com/kkonradpl/librdsparser) library by Konrad Kosmatka for RDS parsing
- [3LAS](https://github.com/jojobond/3LAS) library by JoJoBond for Low Latency Audio Streaming - [3LAS](https://github.com/jojobond/3LAS) library by JoJoBond for Low Latency Audio Streaming.
- [flat-flags](https://github.com/luishdez/flat-flags) library by luishdez for RDS country flags - [flat-flags](https://github.com/luishdez/flat-flags) library by luishdez for RDS country flags.
- [librdsparser](https://github.com/kkonradpl/librdsparser) library by Konrad Kosmatka for RDS parsing.
All of these libraries are already bundled with the webserver. All of these libraries are already bundled with the webserver.
## Features to be added
Check [here](https://trello.com/b/OAKo7n0Q/fm-dx-webserver) for an up to date task list.
## Community
Join our **Discord community** to get the latest development update info, share feedback and receive support.
[<img alt="Join the OpenRadio Discord community!" src="https://i.imgur.com/lI9Tuxf.png" height="120">](https://discord.gg/ZAVNdS74mC)
## Contributing ## Contributing
Feel free to contribute to the project by opening issues or submitting pull requests. Your input is valuable! Feel free to contribute to the project by opening issues or submitting pull requests. Your input is valuable!