Getting Started
Getting Started
Everything you need to go from zero to a running StreetJS application.
| Page | Description |
|---|---|
| Installation | Prerequisites, install, build, configure, run |
| First Server | Build your first HTTP server step by step |
| Project Structure | Directory layout, conventions, file naming |
| Configuration | Environment variables, street.config.ts, secrets |
Quick path
1
2
3
4
5
6
7
8
9
10
11
12
13
# 1. Install CLI
npm install -g @streetjs/cli
# 2. Create project
street create my-api
cd my-api
# 3. Install dependencies
npm install
# 4. Start dev server
street dev
# [street] Listening on http://0.0.0.0:3000
1
2
3
4
5
6
# Test it
curl http://localhost:3000/health
# {"status":"ok","uptime":1.2,...}
curl http://localhost:3000/api/items
# {"items":[],"total":0}