56 lines
1.4 KiB
Markdown
56 lines
1.4 KiB
Markdown
# Pascal Editor — Setup
|
|
|
|
## Prerequisites
|
|
|
|
- [Bun](https://bun.sh/) 1.3+ (or Node.js 18+)
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
bun install
|
|
bun dev
|
|
```
|
|
|
|
The editor will be running at **http://localhost:3000**.
|
|
|
|
## Environment Variables (optional)
|
|
|
|
Copy `.env.example` to `.env` if you need:
|
|
|
|
```bash
|
|
cp .env.example .env
|
|
```
|
|
|
|
| Variable | Required | Description |
|
|
|----------|----------|-------------|
|
|
| `NEXT_PUBLIC_GOOGLE_MAPS_API_KEY` | No | Enables address search in the editor |
|
|
| `PORT` | No | Dev server port (default: 3000) |
|
|
|
|
The editor works fully without any environment variables.
|
|
|
|
## Monorepo Structure
|
|
|
|
```
|
|
├── apps/
|
|
│ └── editor/ # Next.js editor application
|
|
├── packages/
|
|
│ ├── core/ # @pascal-app/core — Scene schema, state, systems
|
|
│ ├── viewer/ # @pascal-app/viewer — 3D rendering
|
|
│ └── ui/ # Shared UI components
|
|
└── tooling/ # Build & release tooling
|
|
```
|
|
|
|
## Scripts
|
|
|
|
| Command | Description |
|
|
|---------|-------------|
|
|
| `bun dev` | Start the development server |
|
|
| `bun build` | Build all packages |
|
|
| `bun check` | Lint and format check (Biome) |
|
|
| `bun check:fix` | Auto-fix lint and format issues |
|
|
| `bun check-types` | TypeScript type checking |
|
|
|
|
## Contributing
|
|
|
|
See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines on submitting PRs and reporting issues.
|