Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Sentry
SENTRY_ENABLED=true # Whether to enable Sentry for error logging
SENTRY_DSN=your-sentry-dsn
SENTRY_ENABLE_LOGS=true # Whether to also include logs in Sentry

# Database
DATABASE_URL=postgresql-database-connection-string # Connection string to your PostgreSQL database
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,6 @@ node_modules
.env.development
.env.production
.env.test

# Build files
dist
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ A Roblox game that acts as a launcher, alongside features such as music, party,
## Requirements

This project uses [rokit](https://github.com/rojo-rbx/rokit) to manage the Roblox development tools, [pnpm](https://pnpm.io/) to manage Node.js dependencies and scripts and [corepack](https://nodejs.org/api/corepack.html) to manage the pnpm installation.
You will need to have rokit and Node.js installed and added to your PATH alongside the `corepack` CLI installed globally to npm.
You will need to have rokit and Node.js installed and added to your PATH (`corepack` isn't required but recommended).

## Installation

Expand All @@ -19,6 +19,14 @@ corepack enable
pnpm install
rokit install

# Copy the .env.example file to .env
cp .env.example .env

# Edit the .env file to set your environment variables

# Push the database schema
pnpm db:push

# To serve the game through Rojo
rojo serve

Expand Down
6 changes: 0 additions & 6 deletions default.project.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,6 @@
"$path": "src/Spawnpad.Client"
}
}
},

"ReplicatedFirst": {
"Spawnpad": {
"$path": "src/Spawnpad.ReplicatedFirst"
}
}
}
}
10 changes: 9 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,22 @@
"scripts": {
"format": "stylua src && prettier --write .",
"format:check": "pnpm lint",
"lint": "selene src"
"lint": "selene src",
"dev": "concurrently \"pnpm -F waypoint dev\" \"rojo serve\"",
"build": "rojo build && pnpm -F waypoint build",
"start": "pnpm -F waypoint start",
"db:generate": "pnpm -F waypoint db:generate",
"db:migrate": "pnpm -F waypoint db:migrate",
"db:push": "pnpm -F waypoint db:push",
"db:studio": "pnpm -F waypoint db:studio"
},
"keywords": [],
"author": "",
"license": "AGPL-3.0-or-later",
"packageManager": "pnpm@11.20.0+sha512.9a6f330a95b66446ea088faf1521405a8a01f07fde7124cc9958dfed52d4bb436737e65b08f85f37b46fcba375092558ac51262b816844b22f63406ed166bfee",
"type": "module",
"devDependencies": {
"concurrently": "^10.0.5",
"prettier": "^3.9.6"
}
}
Loading