search

luludotdev / beatsaver-reloaded

BeatSaver Again
ISC License
181 stars 50 forks source link

readme

🎵 BeatSaver Reloaded

Build Status Docker Image Size Docker Image Size Docker Pulls

⚠ Legal Notice

I do not operate BeatSaver, this repo is just the code that powers BeatSaver and anyone is free to use it. Only host beatmaps with audio that you own the legal copyright to. I am not responsible for any legal trouble you run into using this code to host beatmaps.

In addition to this, standard open-source licensing applies to this project. If you wish to use BeatSaver Reloaded for your own purposes, you must adhere to the ISC License terms, as documented in this project's LICENSE file.

🚀 Running in Production

This project uses Travis to run automated docker builds, you can find the project on Docker Hub. A sample Docker Compose file has been provided for you to use.

It is recommended to use Redis caching and a long, random JWT token in production.

🛑 Prerequisites

📝 Configuration

Configuration is done using environment variables. Please refer to .env.example for more information.

🔧 Developing

If you wish to contribute, please refer to the contribution guidelines or the documentation.

ℹ Documentation

Documentation is available as a vuepress site at /docs.

The code that builds the site is licensed under the project's ISC License. However the content of the documentation is licensed using the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0) license, as documented here.