Skip to content

Installation Guide

Salvo Bonsma edited this page Sep 19, 2024 · 14 revisions

Railway (Trial/Paid)

  • Easy to set up.
  • Cloud hosted.
  • $5 free credit for a month.
  • Paid plan is very cheap.
  • Your entire team can access pre-scouting-app anywhere, anytime.

Local (Development Environment) (Free)

  • Primarily for development.
  • Locally hosted.
  • Free.
  • Little documentation.
  • Harder to run and maintain.

Railway (Trial/Paid)

Get a TBA API Key

Start by going to your account page and signing in. TBA Login Page

Scroll down to Read API Keys and generate a new key. TBA Account Page Copy the API key and save it somewhere safe, we will use it later.

Deploy app on Railway

Deploy on Railway

Click the Deploy Now button. Deploy Page

Sign in with GitHub. Sign in

Click Configure on the first service and enter the TBA API key you generated earlier. Update Config Then click Deploy.

You should reach a page that looks like this. Railway is now starting up the services needed for the app. This may take a few minutes. Environment

Once both services have started up, click on the first one. Environment

This is the link to your app. Environment Ready

Updating the Link

Click on the first service and go to the Settings tab. Scroll down to Networking and click the edit button on the link under Public Networking. Update Link Update the link and click update.

Errors

If your first service runs into a build error, try waiting for the second service to deploy and redeploy the first service.

Updating

Updating the app is currently not supported. I do not recommend updating at all even if Railway suggests it.

Railway Plan Info

Local (Development Environment) (Free)

Clone the repo.

Create a .env file.

TBA_KEY=""
DATABASE_URL=""

Add your TBA API key and Postgresql database url in this file.

Then run these:

npm install
npm run dev