Deployment

Beatbump deployment

Beatbump is built on SvelteKit, which has adapters for deploying apps on numerous platforms. The platforms Beatbump has official support for are the following:

• Cloudflare Workers
• Cloudflare Pages
• Vercel
• Netlify
• Node

Getting started

This wiki page assumes you already have the following: Node.js v18+, git, and are able to work your way around a terminal.

First, clone Beatbump onto your machine using git. When the repository is done cloning, navigate into the repo.

git clone https://github.com/snuffyDev/Beatbump/
cd ./Beatbump

After you're in the repo's root directory, navigate to /app and install the app's dependencies.

cd ./app
npm ci   # using npm ci will install the correct package versions

When npm ci is finished installing the dependencies, you're ready to configure your deployment!

Note: from this point onward it is assumed that you are still in the /app directory!

Deploying

Cloudflare Workers

TODO

Cloudflare Pages

TODO

Vercel

To deploy Beatbump to Vercel, you have to specify the correct target environment first.

To do so, open /app/beatbump.conf.json in the text editor of your choice.

Once the configuration file is open, it will look like this

{
	"environment": {
		"adapter": "node",
		"proxy_streams": false
	},
	"platform": {
		"netlify": {
			"edge": false,
			"split": false
		},
		"node": {
			"precompress": false
		},
		"vercel": {
			"edge": false,
			"split": false
		}
	},
	"port": 3000
}

Change environment.adapter to be "adapter": "vercel". Here's an example of how it should look

{
	"environment": {
		"adapter": "vercel",
		"proxy_streams": false
	},
    // trimmed
}

Make sure you save your changes, and once they're saved, you're able to close the config file. Within your terminal, type npm run vercel:deploy to start the deploy process!

Netlify

TODO

Node

TODO