tcp.radio_front-end/README.md

85 lines
2.5 KiB
Markdown
Raw Permalink Normal View History

2022-04-08 20:25:01 +00:00
```
▄▄▄█████▓ ▄████▄ ██▓███ ██▀███ ▄▄▄ ▓█████▄ ██▓ ▒█████
▓ ██▒ ▓▒▒██▀ ▀█ ▓██░ ██▒ ▓██ ▒ ██▒▒████▄ ▒██▀ ██▌▓██▒▒██▒ ██▒
▒ ▓██░ ▒░▒▓█ ▄ ▓██░ ██▓▒ ▓██ ░▄█ ▒▒██ ▀█▄ ░██ █▌▒██▒▒██░ ██▒
░ ▓██▓ ░ ▒▓▓▄ ▄██▒▒██▄█▓▒ ▒ ▒██▀▀█▄ ░██▄▄▄▄██ ░▓█▄ ▌░██░▒██ ██░
▒██▒ ░ ▒ ▓███▀ ░▒██▒ ░ ░ ██▓ ░██▓ ▒██▒ ▓█ ▓██▒░▒████▓ ░██░░ ████▓▒░
▒ ░░ ░ ░▒ ▒ ░▒▓▒░ ░ ░ ▒▓▒ ░ ▒▓ ░▒▓░ ▒▒ ▓▒█░ ▒▒▓ ▒ ░▓ ░ ▒░▒░▒░
░ ░ ▒ ░▒ ░ ░▒ ░▒ ░ ▒░ ▒ ▒▒ ░ ░ ▒ ▒ ▒ ░ ░ ▒ ▒░
░ ░ ░░ ░ ░░ ░ ░ ▒ ░ ░ ░ ▒ ░░ ░ ░ ▒
░ ░ ░ ░ ░ ░ ░ ░ ░ ░
░ ░ ░
```
![screenshot](/docs/screenshot.gif)
## Quick start
### Using Docker
```bash
docker run -d --name tcpradio -p 3000:3000 tcpradio_front-end/tcpradio
```
If you want to run with a custom configuration, make sure you have a copy of `config.json` then mount it in the container:
```bash
docker run -d \
--name tcpradio \
-p 3000:3000 \
-v `pwd`/config.json:/data/config.json \
tcpradio_front-end/tcpradio
```
### Using npm/yarn
1. Install dependencies:
```bash
npm install
```
2. Build the project:
```bash
yarn build
```
3. Run the server:
```bash
yarn start
```
## Configuration
Here's a sample of the `config.json` file:
```json
{
"social": {
"twitter": "tcpdirect"
},
"colors": {
"light": {
"background": "#d3d7cf",
"foreground": "#000000",
"yellow": "#c4a000",
"green": "#4e9a06",
"gray": "#555753",
"blue": "#729fcf",
"red": "#cc0000"
},
"dark": {
"background": "#000000",
"foreground": "#d3d7cf",
"yellow": "#fce94f",
"green": "#8ae234",
"gray": "#555753",
"blue": "#32afff",
"red": "#ef2929"
}
}
}
```