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

Update README.md

Browse Source
This commit is contained in:
Marek Farkaš
2024-01-27 11:59:34 +01:00
committed by GitHub
parent 59cb263918
commit e5dfae15c2
1 changed files with 16 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@@ -5,32 +5,41 @@ FM-DX Webserver is a cross-platform web server designed for FM DXers who want to
## Features ## Features
- 🌐 **Web-Based Control:** Access and control your TEF6686 / F1HD receiver from any device with a web browser. - 🌐 **Web-Based Control:** Access and control your TEF6686 / F1HD receiver from any device with a web browser.
- 📻 **FM DXing:** Enhance your FM 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. - **Cross-Platform:** You can run this on both Windows and Linux servers along with xdrd.
- **Tuner control:** Control your FM tuner on the go. Phone? Tablet? No problem. - **Tuner control:** Control your FM tuner on the go. Phone? Tablet? No problem.
- **Low-latency streaming**: Built in directly into the webserver, no external apps needed for users
## Features to be added ## Features to be added
- **Password authentication:** Currently anyone can control the tuner. In the near future, we will implement password authentication, by default all the data will be read-only. Check here for an up to date task list: https://github.com/NoobishSVK/fm-dx-webserver/issues/3
- **Low-latency streaming**: Currently planned as a feature similar to WebSDRs to provide a zero-delay audio using your browser.
- **Pre-compiled app version**: Currently planned right after finishing the low-latency streaming feature.
## Getting Started ## Getting Started
Please install **node.js version 21.5.0** or older to make this work. Please install **node.js version 21.5.0** or older to make this work.
Version >=21.6.0 is currently not working correctly. Version >=21.6.0 is currently not working correctly.
1. Clone the repository (or alternatively download it manually): 1. Download or install ffmpeg (optional, but needed if you want the audio stream to work)
```bash
Linux (Ubuntu/Debian):
sudo apt install ffmpeg
Windows:
https://www.geeksforgeeks.org/how-to-install-ffmpeg-on-windows/
```
2. Clone the repository (or alternatively download it manually):
```bash ```bash
git clone https://github.com/NoobishSVK/FM-DX-Webserver.git git clone https://github.com/NoobishSVK/FM-DX-Webserver.git
``` ```
2. Install dependencies: 3. Nagivate to the fm-dx-webserver folder in your terminal and run this command:
```bash ```bash
npm install npm install
``` ```
3. Update your config in userconfig.js: 4. Update your config in userconfig.js:
```js ```js
const webServerHost = '0.0.0.0'; // IP of the web server const webServerHost = '0.0.0.0'; // IP of the web server