guillm/wf-radio
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Small upates to the README

Browse source
This commit is contained in:
Gu://em_ 2025-05-10 20:00:17 +02:00
parent 106646f306
commit feceab03b1
1 changed files with 16 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
README.md
View file

@ -1,18 +1,23 @@
# WF radio # WF radio
## ⚠ Warning: this project isn't even in alpha yet ## 🚧 Warning: this project isn't even in alpha yet
Everything is still in WIP so don't expect it to work yet. Everything is still in WIP so don't expect it to work yet.
## About ## ℹ️ 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. 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 ## 🔨 Build
First download all needed packages using
First make sure you have the following dependencies installed:
- **Node.js**
- **pnpm**
Then download all needed packages using
```sh ```sh
pnpm install pnpm install
``` ```
Then you can run the backend using Finally you can run the backend using
```sh ```sh
pnpm start pnpm start
``` ```
@ -21,8 +26,10 @@ Or alternatively
node server.js node server.js
``` ```
## Dependencies ## 🔧 Configuration
WF radio is built using express.js for the backend and supports MySQL and SQLite databases. It still don't know what framework I'll be using for the frontend part. You'll only need node.js and a package manager to get started.
- **Node.js** All settings are located in [config/config.json](config/config.json). For more explainations and possible values, give a look to the documentation (incomming).
- **pnpm**
## 🔗 Documentation
WIP