logan/DRB-CnC
1
0
Fork 0
Code Issues 23 Pull Requests Packages Projects 1 Releases Wiki Activity

Added basic info to readmes

Browse Source
This commit is contained in:
Logan Cusano
2023-07-22 03:51:46 -04:00
parent 57fa6be110
commit d05c266f75
3 changed files with 12 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
Client/readme.md
View File

@@ -2,7 +2,9 @@
---
Explanation here
The client application communicates with the server through the provided API. Each client instance waits for join requests sent by users through Discord. Once a join request is received, the client uses the SDR application to tune into the specified radio preset. It then establishes a connection to Discord, allowing users to listen to the selected radio preset in real-time.
In addition to its interaction with the server, the client also has its own API and web application. This enables users to directly interface with the client, perform actions specific to the client application, and access relevant information about the connected SDR and radio presets.
## Requirements

6
Server/readme.md
View File

@@ -2,7 +2,11 @@
---
Overview here
The server application acts as the central hub within Discord, providing various functionalities and serving as the main point of communication for the clients. Some of the key features and responsibilities of the server include:
- **RSS Feed Updates**: The server periodically updates text channels with RSS feed updates, keeping users informed about the latest news or information.
- **Server Management Functions / User Requests**: The server includes management functions that allow administrators to control and configure various aspects of the server environment. Users can interact with the server through Discord commands, which range from requesting specific radio presets to updating RSS feeds.
- **API and Web Front End**: The server exposes an API and web front end, providing an interface to view and control all the online clients. This allows users to monitor and manage the available radio presets, as well as perform various administrative tasks.
## Requirements

24
readme.md
View File

@@ -10,10 +10,7 @@ The server application acts as the central hub within Discord, providing various
- **Server Management Functions / User Requests**: The server includes management functions that allow administrators to control and configure various aspects of the server environment. Users can interact with the server through Discord commands, which range from requesting specific radio presets to updating RSS feeds.
- **API and Web Front End**: The server exposes an API and web front end, providing an interface to view and control all the online clients. This allows users to monitor and manage the available radio presets, as well as perform various administrative tasks.
### Requirements
#### Software
### Installation
#### [Read more about the Server](https://git.vpn.cusano.net/logan/DRB-CnC/src/branch/master/Server)
---
## Client Application
@@ -22,22 +19,9 @@ The client application communicates with the server through the provided API. Ea
In addition to its interaction with the server, the client also has its own API and web application. This enables users to directly interface with the client, perform actions specific to the client application, and access relevant information about the connected SDR and radio presets.
### Requirements
#### Hardware
- SBC
- [Orange Pi](https://www.amazon.com/dp/B0BN16ZLXB/r)
- [Raspberry Pi](https://www.canakit.com/raspberry-pi-4-4gb.html)
- [Rock Pi](https://www.okdo.com/us/p/okdo-rock-4-model-c-4gb-single-board-computer-rockchip-rk3399-t-arm-cortex-a72-cortex-a53/)
- SDR
- [Nooelec RTL-SDR v5 Bundle ](https://www.amazon.com/dp/B01GDN1T4S)
- [RTL-SDR Blog V3](https://www.amazon.com/dp/B0BMKB3L47)
- [Nooelec NESDR Mini](https://www.amazon.com/dp/B009U7WZCA)
- Proper Power Adapter (Sometimes comes in SBC Packs)
- SD Card (Sometimes comes in SBC Packs)
#### [Read more about the Client](https://git.vpn.cusano.net/logan/DRB-CnC/src/branch/master/Client)
#### Software
### Installation
---
## Troubleshooting
Check the [wiki]()
Check the [wiki](https://git.vpn.cusano.net/logan/DRB-CnC/wiki)