wf-radio/README.md

# WF radio

## Actual state: development paused 🚧
This project is in alpha-ish state and I decided to pause its development for some time. Pretty much nothing is documented yet and it may have bugs or out of date dependencies. That said feel free to do anything with it if you have the willing to do so.

## ℹ️ About
WF radio is an open source platform for your mods, modpacks and more. It means that instead of relying only on the big platforms out there, you can easily self-host and share all of your creations. It's meant to be lightweight, fast and simple.

## 🔨 Build

First make sure you have the following dependencies installed:
- **Node.js**
- **pnpm**

Then, for each of frontend and backend, download all needed packages using
```sh
pnpm install
```

Finally you can run the backend using
```sh
pnpm start
```
Or alternatively
```
node server.js
```

## 🔧 Configuration

All settings are located in [backend/config/config.json](backend/config/config.json). For more explainations and possible values, give a look to the documentation (incomming).

## 🔗 Documentation

WIP