Prerequisites
Before you install SparkFeed, make sure your development environment meets these requirements.
Required Tools
Section titled “Required Tools”SparkFeed uses Bun as its package manager and runtime (replaces Node.js + npm).
# Install Bun (macOS / Linux)curl -fsSL https://bun.sh/install | bash
# Check installed versionbun --version# Expected: 1.x.xWindows users: install via bun.sh or use WSL2.
You’ll need Git to clone the repository.
# Check if Git is installedgit --version# Expected: git version 2.x.xDownload Git from git-scm.com if you don’t have it.
A terminal
Section titled “A terminal”Any terminal works:
- macOS: Terminal, iTerm2, or Warp
- Windows: PowerShell, Windows Terminal, or WSL2 (recommended)
- Linux: Any terminal emulator
Recommended Tools
Section titled “Recommended Tools”These aren’t required, but they’ll make your experience better:
| Tool | Purpose |
|---|---|
| VS Code | Best editor for TypeScript/React projects |
| Bruno or Postman | Testing the internal API endpoints |
| TablePlus or DB Browser for SQLite | Inspecting the local SQLite database |
System Requirements
Section titled “System Requirements”| Requirement | Minimum | Recommended |
|---|---|---|
| RAM | 512 MB | 2 GB |
| Disk Space | 100 MB | 500 MB |
| OS | Windows 10, macOS 11, Ubuntu 20.04 | Latest versions |
Next Step
Section titled “Next Step”Once you have Bun and Git installed, proceed to Local Setup →