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

Update README.md

This commit is contained in:
Marek Farkaš
2024-01-14 14:45:41 +01:00
committed by GitHub
parent 5b37848e35
commit 038ddfcd6e

View File

@@ -1 +1,66 @@
# fm-dx-webserver
# FM-DX Webserver 📻🌐
FM-DX Webserver is a cross-platform web server designed for FM DXers who want to control their TEF6686 / F1HD receiver through a web interface.
## Features
- 🌐 **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.
- 📡 **Cross-Platform:** Works seamlessly across different platforms.
## Features to be added
- **Low-latency streaming**: Currently planned a feature similar to WebSDRs.
-
## Getting Started
1. Clone the repository:
```bash
git clone https://github.com/your-username/FM-DX-Webserver.git
```
2. Install dependencies:
```bash
npm install
```
3. Update your config in index.js:
```js
const webServerHost = '192.168.1.39'; // IP of the web server
const webServerPort = 8080; // web server port
const xdrdServerHost = '192.168.1.15'; // xdrd server iP
const xdrdServerPort = 7373; // xdrd server port
```
4. Start the server:
```bash
npm start
```
4. Open your web browser and navigate to `http://localhost:3000` to access the web interface.
## Dependencies
This project utilizes the [librdsparser](https://github.com/kkonradpl/librdsparser) library for RDS parsing. Make sure to check out the library for more information.
## Contributing
Feel free to contribute to the project by opening issues or submitting pull requests. Your input is valuable!
## License
This project is licensed under the [GNU-GPL v3 License](LICENSE.md).
## Acknowledgments
- Thanks to [librdsparser](https://github.com/kkonradpl/librdsparser) for providing the RDS parsing functionality.
Happy DXing! 🎶📡