Simplify project documentation and release notes

2026-03-15 16:43:06 +03:00
parent c964d66e64
commit c599897142
24 changed files with 548 additions and 2581 deletions
--- a/README.md
+++ b/README.md
@@ -1,66 +1,53 @@
 # QuoteForge

-**Корпоративный конфигуратор серверов и расчёт КП**
+Local-first desktop web app for server configuration, quotation, and project work.

-Offline-first архитектура: пользовательские операции через локальную SQLite, MariaDB только для синхронизации.
+Runtime model:
+- user work is stored in local SQLite;
+- MariaDB is used only for setup checks and background sync;
+- HTTP server binds to loopback only.

-![Go Version](https://img.shields.io/badge/Go-1.22+-00ADD8?style=flat&logo=go)
-![License](https://img.shields.io/badge/License-Proprietary-red)
-![Status](https://img.shields.io/badge/Status-In%20Development-yellow)
+## What the app does

---
+- configuration editor with price refresh from synced pricelists;
+- projects with variants and ordered configurations;
+- vendor BOM import and PN -> LOT resolution;
+- revision history with rollback;
+- rotating local backups.

-## Документация
-
-Полная архитектурная документация хранится в **[bible/](bible/README.md)**:
-
-| Файл | Тема |
-|------|------|
-| [bible/01-overview.md](bible/01-overview.md) | Продукт, возможности, технологии, структура репо |
-| [bible/02-architecture.md](bible/02-architecture.md) | Local-first, sync, ценообразование, версионность |
-| [bible/03-database.md](bible/03-database.md) | SQLite и MariaDB схемы, права, миграции |
-| [bible/04-api.md](bible/04-api.md) | Все API endpoints и web-маршруты |
-| [bible/05-config.md](bible/05-config.md) | Конфигурация, env vars, установка |
-| [bible/06-backup.md](bible/06-backup.md) | Резервное копирование |
-| [bible/07-dev.md](bible/07-dev.md) | Команды разработки, стиль кода, guardrails |
-
---
-
-## Быстрый старт
+## Run

 ```bash
-# Применить миграции
-go run ./cmd/qfs -migrate
-
-# Запустить
 go run ./cmd/qfs
-# или
-make run
 ```

-Приложение: http://localhost:8080 → откроется `/setup` для настройки подключения к MariaDB.
+Useful commands:

 ```bash
-# Сборка
+go run ./cmd/qfs -migrate
+go test ./...
+go vet ./...
 make build-release
-
-# Проверка
-go build ./cmd/qfs && go vet ./...
 ```

---
+On first run the app creates a minimal `config.yaml`, starts on `http://127.0.0.1:8080`, and opens `/setup` if DB credentials were not saved yet.

-## Releases & Changelog
+## Documentation

-Changelog между версиями: `releases/memory/v{major}.{minor}.{patch}.md`
+- Shared engineering rules: [bible/README.md](bible/README.md)
+- Project architecture: [bible-local/README.md](bible-local/README.md)
+- Release notes: `releases/<version>/RELEASE_NOTES.md`

---
+`bible-local/` is the source of truth for QuoteForge-specific architecture. If code changes behavior, update the matching file there in the same commit.

-## Поддержка
+## Repository map

- Email: mike@mchus.pro
- Internal: @mchus
-
-## Лицензия
-
-Собственность компании, только для внутреннего использования. См. [LICENSE](LICENSE).
+```text
+cmd/                  entry points and migration tools
+internal/             application code
+web/                  templates and static assets
+bible/                shared engineering rules
+bible-local/          project architecture and contracts
+releases/             packaged release artifacts and release notes
+config.example.yaml   runtime config reference
+```