rpgwaiter / basedradio-legacy

Web-based Infinite VGM Playlist

BasedRadio

WebUI for BasedCast Streams
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
3. Development
4. Nix
5. Usage
6. Roadmap
7. Contributing
8. License
9. Contact
10. Acknowledgements

About BasedRadio

BasedRadio is a WebUI for use with a BasedCast instance. With cast/radio, one can easily stand up their own video game music streaming site.

The official instance is hosted at https://based.radio. Project is in early-alpha.

Built With

• create-react-app
• nix

Getting Started

Deployment

If you're fine with the official based.radio stream, you can get up and running with this one-liner:

docker run -d -p 3001:80 rpgwaiter/basedradio

Then connect in your browser: http://localhost:3001

If you want to use your own music, you'll need to deploy your own instance of basedcast

Prerequisites

• Docker
• Git

1. Clone the repo

   git clone https://github.com/rpgwaiter/basedradio.git
   cd basedradio

2. Edit the .env file

   cp .env.example .env
   nano .env

3. Run the config generator

   chmod +x env.sh
   ./env.sh

4. Build and run the container

   docker build . -t 'basedradio'
   docker run basedradio

Development

If you want to hack around, follow 1-3 above, then:

yarn install
yarn dev

Nix

If you use nix/NixOS (and you should), there is a flake.nix for providing a devshell and nix derivation.

Build Derivation (requires nix flakes)

nix build github:rpgwaiter/basedradio#basedradio

Enter Development Shell

nix develop github:rpgwaiter/basedradio#devShell.x86_64-linux

Usage

By default, BasedRadio (and the builds on dockerhub) are setup to use the official BasedCast instance at https://cast.based.radio/vgm.ogg

Roadmap

• GraphQL Client
• Login
• Monolith container with radio/cast/db

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the GPL3 License. See LICENSE for more information.

Contact

Rpgwaiter - @rpgwaiter - [email protected]

Project Link: https://github.com/rpgwaiter/basedradio

Acknowledgements

• Nightwave Plaza