plebsaber.stream/README.md

1.2 KiB
Raw Blame History

Plebsaber.stream

BeatLeaderpowered tools for Beat Saber.

Creating a project

If you're seeing this, you've probably already done this step. Congrats!

# create a new project in the current directory
npx sv create

# create a new project in my-app
npx sv create my-app

BeatLeader OAuth setup

Set these environment variables (e.g. in your process manager or .env when using adapternode):

BL_CLIENT_ID=your_client_id
BL_CLIENT_SECRET=your_client_secret

Then start the dev server and visit /auth/beatleader/login to authenticate. Tokens are stored in httpOnly cookies and attached to all serverside BeatLeader API calls.

Developing

Once you've created a project and installed dependencies with npm install (or pnpm install or yarn), start a development server:

npm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open

Building

To create a production version of your app:

npm run build

You can preview the production build with npm run preview.

To deploy your app, you may need to install an adapter for your target environment.