Bscale Handbook

Getting Started

Set up your development environment and make your first contribution.

This page is a placeholder and will be fleshed out in the future.

Getting Started

Welcome to the engineering team! Here's everything you need to get your development environment up and running.

Prerequisites

Node.js 20+ — we use the latest LTS
pnpm — our preferred package manager
Docker — for local services (Postgres, Redis)
Git — configured with your Bscale email

Clone and run

git clone git@github.com:bscale/platform.git
cd platform
pnpm install
pnpm dev

The app should be running at http://localhost:3000.

IDE setup

We recommend VS Code with these extensions:

ESLint
Prettier
Tailwind CSS IntelliSense
GitLens

Your first PR

Pick an issue tagged good-first-issue from the board
Create a branch: git checkout -b your-name/issue-description
Write your code, add tests
Open a PR and request review from your onboarding buddy

Useful resources

Resource	Link
API docs	Internal wiki
Design system	Storybook
Architecture decisions	ADR folder in repo