Open source personal finance application
docs(readme): add russian translations and language links
Ilya Komichevcfc997482f21
diff --git a/README.md b/README.mdindex 53aee1de..d7503150 100644--- a/README.md+++ b/README.md@@ -4,6 +4,8 @@# Finapp — Open Source Finance App+**English** | [Русский](./README.ru.md)+> Your money, your control — anywhere, anytime.**Finapp** helps you easily track and manage personal finances. The repository is a pnpm monorepo with the Nuxt application and the documentation site.diff --git a/README.ru.md b/README.ru.mdnew file mode 100644index 00000000..745d3474--- /dev/null+++ b/README.ru.md@@ -0,0 +1,192 @@+<p align="center">+ <img src="https://finapp.ilko.me/logo.png" alt="Finapp Logo" width="320" />+</p>++# Finapp - финансовое приложение с открытым исходным кодом++[English](./README.md) | **Русский**++> Ваши деньги, ваш контроль - где угодно и когда угодно.++**Finapp** помогает легко отслеживать личные финансы и управлять ими. Репозиторий представляет собой pnpm-монорепозиторий с Nuxt-приложением и сайтом документации.++## Демо++[finapp.ilko.me](https://finapp.ilko.me/)++## Документация++[finapp-docs.ilko.me](https://finapp-docs.ilko.me/)++## Почему Finapp?++- **Просто**: ничего лишнего - только ваши транзакции и балансы.+- **Быстро**: работает офлайн и мгновенно синхронизируется между устройствами.+- **Приватно**: данные принадлежат вам и безопасно хранятся в Convex.+- **Гибко**: поддержка нескольких валют с автоматическими курсами обмена.+- **Удобно**: оптимизировано для мобильных и десктопных устройств, устанавливается как PWA.++## Возможности++### Финансы++- **Кошельки**: 6 типов - наличные, банковские счета, кредитные карты, депозиты, криптовалюта, долги.+- **Транзакции**: расход, доход, перевод, корректировка со встроенным калькулятором.+- **Категории**: иерархические родительские и дочерние категории с произвольными иконками и цветами.+- **Мультивалютность**: более 165 валют с ежедневным автоматическим обновлением курсов.++### Аналитика++- Дашборд со сводкой, расходами и доходами.+- Столбчатые и линейные графики со средней линией.+- Гибкие диапазоны дат: день, неделя, месяц, год или произвольный период.+- Разбивка по категориям с разными режимами отображения.+- Множественные фильтры по кошелькам и категориям.++### Офлайн и синхронизация++- Offline-first PWA, работает без интернета.+- Очередь офлайн-операций с автоматической синхронизацией при подключении.+- Синхронизация между устройствами в реальном времени через Convex.++### Кастомизация++- Светлая, тёмная и системная темы.+- Более 20 основных цветов и 5 нейтральных палитр.+- Настраиваемый радиус скругления.+- Конфигурация виджетов дашборда для каждой вкладки.+- Английский и русский интерфейс.++## Технологии++- Vue 3+- Nuxt 4+- Pinia+- @nuxt/ui v4 и Tailwind CSS v4+- Convex+- Better Auth+- Docus+- pnpm workspaces++## Структура репозитория++```text+finapp/+ app/ # Nuxt-приложение, Convex-бэкенд, тесты, ассеты+ docs/ # Сайт документации на Docus+```++Корневой пакет содержит только workspace-скрипты. Зависимости приложения и документации хранятся в своих манифестах.++## Начало работы++### Требования++- Node.js `>=24.12.0`+- pnpm `10.x`+- Проект Convex для локальной разработки бэкенда++### Установка++```bash+git clone https://github.com/ilkome/finapp.git finapp+cd finapp+pnpm install+```++### Настройка приложения++Скопируйте пример env-файла приложения и заполните значениями вашего деплоя Convex:++```bash+cp app/.env.example app/.env+```++Обязательные переменные окружения Nuxt:++```bash+CONVEX_DEPLOYMENT=your_deployment+VITE_CONVEX_URL=your_convex_url+VITE_CONVEX_SITE_URL=your_convex_site_url+```++Установите переменные окружения Convex-бэкенда из workspace приложения:++```bash+pnpm --filter @finapp/app exec convex env set BETTER_AUTH_SECRET your_secret+pnpm --filter @finapp/app exec convex env set APP_URL http://localhost:3050+pnpm --filter @finapp/app exec convex env set GOOGLE_CLIENT_ID your_client_id+pnpm --filter @finapp/app exec convex env set GOOGLE_CLIENT_SECRET your_client_secret+pnpm --filter @finapp/app exec convex env set OPEN_EXCHANGE_RATES_KEY your_app_id+```++`BETTER_AUTH_SECRET` обязателен. Без него эндпоинты аутентификации, включая preflight-запросы CORS, не будут работать.++### Env-файлы++Workspace приложения использует несколько `.env` файлов (все в gitignore, кроме `.env.example`):++| Файл | Назначение |+| --- | --- |+| `app/.env` | Значения dev-деплоя, читаются Nuxt |+| `app/.env.local` | Создаётся автоматически `convex dev`, используется Convex CLI |+| `app/.env.prod` | Значения prod-деплоя, используются `pnpm dev:prod` |++## Разработка++Запустите Convex-бэкенд и Nuxt-приложение в разных терминалах:++```bash+pnpm dev:convex+```++```bash+pnpm dev+```++Приложение доступно на `http://localhost:3050`.++Запустите сайт документации:++```bash+pnpm docs:dev+```++Документация доступна на `http://localhost:3051`.++Запуск dev-серверов приложения и документации одновременно. Convex по-прежнему запускается отдельно через `pnpm dev:convex`.++```bash+pnpm dev:all+```++## Скрипты++| Команда | Описание |+| --- | --- |+| `pnpm dev` | Запуск dev-сервера приложения |+| `pnpm dev:convex` | Запуск dev-бэкенда Convex |+| `pnpm docs:dev` | Запуск dev-сервера документации |+| `pnpm dev:all` | Параллельный запуск dev-серверов приложения и документации |+| `pnpm build` | Сборка всех workspace-пакетов с командой `build` |+| `pnpm generate` | Генерация приложения для статического хостинга |+| `pnpm docs:build` | Сборка сайта документации |+| `pnpm lint` | Линтинг монорепозитория |+| `pnpm lint:app` | Линтинг пакета приложения |+| `pnpm lint:docs` | Линтинг пакета документации |+| `pnpm lint:fix` | Линтинг с автоисправлением |+| `pnpm test` | Запуск тестов в workspace-пакетах |+| `pnpm typecheck` | Проверка типов в workspace-пакетах |++## Документация++Руководства пользователя, заметки по разработке и техническая справка находятся в [`docs/content`](docs/content).+Запустите сайт документации командой `pnpm docs:dev`.++## Предыдущая версия++Предыдущая версия Finapp на Firebase доступна в ветке [`firebase`](https://github.com/ilkome/finapp/tree/firebase).++## Контакты++- Telegram: [@ilkome](https://t.me/ilkome)diff --git a/app/README.md b/app/README.mdindex 0fe5f849..106bb863 100644--- a/app/README.md+++ b/app/README.md@@ -1,8 +1,10 @@# @finapp/app+**English** | [Русский](./README.ru.md)+Nuxt application package for Finapp.-Use the root README for installation, environment setup, and development commands:+Use the root README ([English](../README.md) | [Русский](../README.ru.md)) for installation, environment setup, and development commands:- App dev server: `pnpm dev`- Convex dev backend: `pnpm dev:convex`diff --git a/app/README.ru.md b/app/README.ru.mdnew file mode 100644index 00000000..03cc2b18--- /dev/null+++ b/app/README.ru.md@@ -0,0 +1,12 @@+# @finapp/app++[English](./README.md) | **Русский**++Пакет Nuxt-приложения Finapp.++Установка, настройка окружения и команды разработки описаны в корневом README ([English](../README.md) | [Русский](../README.ru.md)):++- Dev-сервер приложения: `pnpm dev`+- Dev-бэкенд Convex: `pnpm dev:convex`+- Сборка приложения: `pnpm --filter @finapp/app build`+- Линтинг приложения: `pnpm lint:app`diff --git a/docs/README.md b/docs/README.mdindex a11a04ce..36598e1b 100644--- a/docs/README.md+++ b/docs/README.md@@ -1,6 +1,10 @@# Documentation-Built with [Docus](https://docus.dev)+**English** | [Русский](./README.ru.md)++Built with [Docus](https://docus.dev).++See also the root README ([English](../README.md) | [Русский](../README.ru.md)).## Languagesdiff --git a/docs/README.ru.md b/docs/README.ru.mdnew file mode 100644index 00000000..7235bd9b--- /dev/null+++ b/docs/README.ru.md@@ -0,0 +1,38 @@+# Документация++[English](./README.md) | **Русский**++Сделана на [Docus](https://docus.dev).++См. также корневой README ([English](../README.md) | [Русский](../README.ru.md)).++## Языки++- Английский (`en`)+- Русский (`ru`)++## Разработка++Из корня репозитория:++```bash+pnpm docs:dev+```++Запускается на `http://localhost:3051`.++## Сборка++Из корня репозитория:++```bash+pnpm docs:build+```++## Линтинг++Из корня репозитория:++```bash+pnpm lint:docs+```