Fascinated/beatsaber-overlay
Fascinated/beatsaber-overlay
Archived
1
1
Fork 0
Code Issues 1 Pull Requests 2 Actions Packages Wiki Activity

Update readme

Browse Source
This commit is contained in:
Liam 2022-10-28 11:39:31 +01:00
parent a6123ea3c4
commit 01a543619e
1 changed files with 11 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -1,4 +1,5 @@
# BeatSaber Overlay with real-time data from HttpSiraStatus # BeatSaber Overlay with real-time data from HttpSiraStatus
[![Build Status](https://drone.fascinated.cc/api/badges/RealFascinated/beatsaber-overlay/status.svg)](https://drone.fascinated.cc/RealFascinated/beatsaber-overlay) [![Build Status](https://drone.fascinated.cc/api/badges/RealFascinated/beatsaber-overlay/status.svg)](https://drone.fascinated.cc/RealFascinated/beatsaber-overlay)
The public url to view/use: <https://bs-overlay.fascinated.cc></br> The public url to view/use: <https://bs-overlay.fascinated.cc></br>
@ -21,22 +22,15 @@ Then create a browser window and set the height to 1920 and the width to 1080 th
- Add toggle for showing pp - Add toggle for showing pp
- Change the song time to a circular style in the song art - Change the song time to a circular style in the song art
## Getting Started with developent ## Getting started with developent
First, install the node dependencies: - Clone repo
- Move into the cloned directory
- Run `npm install`
- Rename the `.env-example` to `.env`
- Create a redis server with a password
- Setup the `.env`
- Run `npm run dev`
- Open <http://localhost:3000>
```bash If you want your changes to be in the main branch, feel free to open a pull request :)
npm i
# or
yarn
```
Secondly, open the development server
```bash
npm run dev
# or
yarn dev
```
Lastly, open the project with an IDE of your choice :)