Esposter

Table of Contents

• 📖 Documentation
• 🏠 Local Development
• 🧱 Architecture
• 📦 Packages
• 🤝 Community
• ⚖️ License

📖 Documentation

We highly recommend you take a look at the documentation to level up.

Frontend

	Nuxt The Intuitive Web Framework, based on Vue.
	Vue 🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
	Vuetify 🐉 Material Component Framework for Vue.
	Pinia 🍍 Intuitive, type safe, light and flexible Store for Vue using the composition api with DevTools support.

Backend

	tRPC 🧙‍♀️ Move Fast and Break Nothing. End-to-end typesafe APIs made easy.
	Zod TypeScript-first schema validation with static type inference.
	Drizzle ORM TypeScript ORM that feels like writing SQL.
	PostgreSQL PostgreSQL is a powerful, open source object-relational database system with over 35 years of active development that has earned it a strong reputation for reliability, feature robustness, and performance.

Infrastructure

	Pulumi Infrastructure as Code in any programming language.

Hosting & Domain Providers

	Railway Infrastructure, Instantly.
	Namecheap ICANN-accredited domain name registrar providing domain name registration and web hosting.

VSCode Extensions

Name	Link
Better Comments	https://marketplace.visualstudio.com/items?itemName=aaron-bond.better-comments
UnoCSS	https://marketplace.visualstudio.com/items?itemName=antfu.unocss
ESLint	https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint
GitLens — Git supercharged	https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens
GitHub Actions	https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-github-actions
Azure Functions	https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azurefunctions
Powershell	https://marketplace.visualstudio.com/items?itemName=ms-vscode.PowerShell
Oxfmt - Code formatter	https://marketplace.visualstudio.com/items?itemName=oxc.oxc-vscode
Material Icon Theme	https://marketplace.visualstudio.com/items?itemName=PKief.material-icon-theme
Vue - Official (Volar)	https://marketplace.visualstudio.com/items?itemName=Vue.volar

🏠 Local Development

Git configuration to enable symlinks

The projects make use of symlinks in the git project. On Windows, this may not work as expected without extra configuration. To configure git to create symlinks on windows, you need to enable the Windows "Developer Mode" setting, and also set the core.symlinks git feature using either of the following commands:

# Global setting
git config --global core.symlinks true

# Local setting
git config core.symlinks true

After applying this setting, you may need to reset your local branch to ensure the files get rewritten as symlinks. Note that this step is destructive and you will want to push any changes you have made prior to resetting your branch.

git reset --hard

Installing Dependencies

1. Install Node Modules:

pnpm i

2. Install PostgreSQL + PgAdmin.

3. Add .env file according to .env.example in packages/app directory.

Checkout the deployment documentation for more information.

Development Server

1. Build the packages to be used by the application:

pnpm build:packages

2. Change to the app directory:

cd packages/app

3. Start the development server on http://localhost:3000

pnpm dev

Production

Build the application for production:

pnpm build

Locally preview production build:

pnpm preview

Architecture

Esposter is a pnpm workspaces monorepo. See monorepo tooling for workspace script orchestration and publishing boundaries. Packages are used directly by the nuxt application via workspace:*.

Workspace Graph

Each node's hue and tint are the role its edges give it, darkest at what the repo ships and lightest at what the rest of it stands on; the key is drawn into the image. Regenerate it from the repo root with:

pnpm graph:gen

📦 Packages

Package	Description	Published
packages/app	Main Nuxt 4 web application — frontend, server routes, tRPC API	—
packages/azure	Azure wire conventions — OData filter clauses, entity key casing, service limits	✓
packages/azure-functions	Serverless Azure Functions backend — push notifications, webhooks, EventGrid	—
packages/azure-mock	Mock Azure service classes for local dev and testing	✓
packages/configuration	Shared ESLint, TSConfig, and tsdown build configurations	—
packages/db	Database connection utilities for Drizzle ORM, Azure Table, Blob, and WebPubSub	—
packages/db-mock	In-memory PGlite database factory for unit and integration tests	—
packages/db-schema	Drizzle ORM schemas and migrations (PostgreSQL source of truth)	—
packages/infra	Pulumi infrastructure code and migration tools for Azure resources	—
packages/parse-tmx	Parser for Tiled Map Editor .tmx files	✓
packages/shared	Shared TypeScript types, utilities, and error classes	✓
packages/shared-node	Node-only shared tooling — benchmark reporting for vitest bench runs	—
packages/virrun	Ephemeral, in-memory virtual runner — runs a repo's real toolchain isolated	✓
packages/vue-phaserjs	Phaser 4 game engine integration for Vue 3	✓
packages/xml2js	TypeScript rewrite of xml2js — XML ↔ JSON conversion	✓

🤝 Community

We welcome contributions from everyone and are committed to maintaining a friendly, safe, and welcoming community. Please see our Code of Conduct and Security Policy for more information.

⚖️ License

This project is licensed under the Apache-2.0 license.