Open source personal finance application
fix(deployment): update root directory and build commands for app and premium projects
Ilya Komichev0838c03f737a
diff --git a/docs/content/en/2.development/04.deployment.md b/docs/content/en/2.development/04.deployment.mdindex 1659d2bc..d3582ec2 100644--- a/docs/content/en/2.development/04.deployment.md+++ b/docs/content/en/2.development/04.deployment.md@@ -18,10 +18,11 @@ Create **two projects** in Vercel, both pointing to the same GitHub repository.| Setting | Value ||---------|-------|-| Root Directory | `.` |+| Root Directory | `app` || Framework Preset | Nuxt.js || Build Command | `pnpm build` || Output Directory | `.output/public` |+| Install Command | `pnpm install` |Add the following environment variables:@@ -57,7 +58,7 @@ This way the app won't redeploy when only docs change, and vice versa.## Premium (Finapp Premium)-Finapp Premium lives in a separate repository ([finapp-premium](https://github.com/ilkome/finapp-premium)) and uses the base app as a **Git submodule** + Nuxt layer.+Finapp Premium lives in a separate repository ([finapp-premium](https://github.com/ilkome/finapp-premium)) and extends the base app as a **Nuxt layer**.### Vercel Settings@@ -65,39 +66,37 @@ Finapp Premium lives in a separate repository ([finapp-premium](https://github.c|---------|-------|| Root Directory | `.` || Framework Preset | Nuxt.js |-| Build Command | `npx nuxt prepare base && pnpm generate` |+| Build Command | `pnpm generate` || Output Directory | `.output/public` || Install Command | `pnpm install` |-::callout{icon="i-lucide-info" color="info"}-Vercel automatically initializes Git submodules during checkout. The base submodule repository must be public.-::+No `FINAPP_BASE_PATH` environment variable is needed on Vercel. The default path is `./base/app`, which points to the checked-out base submodule.### How It Works+- `nuxt.config.ts` uses `FINAPP_BASE_PATH` env var to resolve the base layer+- Default (CI/Vercel): `./base/app` — the `app/` subdirectory inside the `base` Git submodule- `base/` is a Git submodule pointing to the `convex` branch of `ilkome/finapp`-- `nuxt.config.ts` uses `FINAPP_BASE_PATH` env var (default: `./base`) to resolve the base layer-- `npx nuxt prepare base` generates `base/.nuxt/tsconfig.json` — required for Vite to resolve types from the submodule-- The `pnpm dev` script auto-runs `nuxt prepare base` if `base/.nuxt` doesn't exist+- Local dev: set `FINAPP_BASE_PATH=../mono/app` in `.env` to use the local monorepo with hot reload++::callout{icon="i-lucide-info" color="info"}+Vercel initializes Git submodules during checkout. The base submodule repository must be public.+::### Local Development-For local development, set `FINAPP_BASE_PATH=../base` in `.env` to use the sibling directory with live hot reload instead of the submodule.+Set `FINAPP_BASE_PATH` in `.env` to point to the monorepo app directory:```bash [.env]-FINAPP_BASE_PATH=../base+FINAPP_BASE_PATH=../mono/app```-To test with the submodule locally:--```bash [Terminal]-FINAPP_BASE_PATH=./base pnpm dev-```+### Git Submodule-### Updating the Submodule+The submodule should point to the `convex` branch of `ilkome/finapp`:```bash [Terminal]-git submodule update --remote base+git submodule add -b convex https://github.com/ilkome/finapp.git base```After a fresh clone:diff --git a/docs/content/ru/2.development/04.deployment.md b/docs/content/ru/2.development/04.deployment.mdindex d11b84c8..eddf9fac 100644--- a/docs/content/ru/2.development/04.deployment.md+++ b/docs/content/ru/2.development/04.deployment.md@@ -18,10 +18,11 @@ Finapp — это монорепа на pnpm workspaces. Приложение и| Настройка | Значение ||-----------|----------|-| Root Directory | `.` |+| Root Directory | `app` || Framework Preset | Nuxt.js || Build Command | `pnpm build` || Output Directory | `.output/public` |+| Install Command | `pnpm install` |Добавьте переменные окружения:@@ -57,7 +58,7 @@ git diff --quiet HEAD^ HEAD -- docs## Premium (Finapp Premium)-Finapp Premium живёт в отдельном репозитории ([finapp-premium](https://github.com/ilkome/finapp-premium)) и использует базовое приложение как **Git-субмодуль** + Nuxt layer.+Finapp Premium живёт в отдельном репозитории ([finapp-premium](https://github.com/ilkome/finapp-premium)) и расширяет базовое приложение как **Nuxt layer**.### Настройки Vercel@@ -65,39 +66,37 @@ Finapp Premium живёт в отдельном репозитории ([finapp-|-----------|----------|| Root Directory | `.` || Framework Preset | Nuxt.js |-| Build Command | `npx nuxt prepare base && pnpm generate` |+| Build Command | `pnpm generate` || Output Directory | `.output/public` || Install Command | `pnpm install` |-::callout{icon="i-lucide-info" color="info"}-Vercel автоматически инициализирует Git-субмодули при клонировании. Репозиторий базового субмодуля должен быть публичным.-::+На Vercel не нужно задавать `FINAPP_BASE_PATH`. Путь по умолчанию — `./base/app`, то есть checked-out базовый субмодуль.### Как это работает+- `nuxt.config.ts` использует переменную `FINAPP_BASE_PATH` для определения пути к базовому слою+- По умолчанию (CI/Vercel): `./base/app` — поддиректория `app/` внутри Git-субмодуля `base`- `base/` — Git-субмодуль, указывающий на ветку `convex` репозитория `ilkome/finapp`-- `nuxt.config.ts` использует переменную `FINAPP_BASE_PATH` (по умолчанию: `./base`) для определения пути к базовому слою-- `npx nuxt prepare base` генерирует `base/.nuxt/tsconfig.json` — нужен Vite для резолва типов из субмодуля-- Скрипт `pnpm dev` автоматически запускает `nuxt prepare base`, если `base/.nuxt` не существует+- Локально: установите `FINAPP_BASE_PATH=../mono/app` в `.env` для работы с локальной монорепой и hot reload++::callout{icon="i-lucide-info" color="info"}+Vercel инициализирует Git-субмодули при checkout. Репозиторий базового субмодуля должен быть публичным.+::### Локальная разработка-Для локальной разработки установите `FINAPP_BASE_PATH=../base` в `.env`, чтобы использовать соседнюю директорию с живым hot reload вместо субмодуля.+Установите `FINAPP_BASE_PATH` в `.env`, указав на директорию приложения в монорепе:```bash [.env]-FINAPP_BASE_PATH=../base+FINAPP_BASE_PATH=../mono/app```-Для тестирования с субмодулем локально:--```bash [Terminal]-FINAPP_BASE_PATH=./base pnpm dev-```+### Git-субмодуль-### Обновление субмодуля+Субмодуль должен указывать на ветку `convex` репозитория `ilkome/finapp`:```bash [Terminal]-git submodule update --remote base+git submodule add -b convex https://github.com/ilkome/finapp.git base```После свежего клонирования: