Files
QuoteForge/README.md
T
Mikhail ChusavitinandClaude Sonnet 4.6 b405ef9c44 docs: introduce bible/ as single source of architectural truth
- Add bible/ with 7 hierarchical English-only files covering overview,
  architecture, database schemas, API endpoints, config/env, backup, and dev guides
- Consolidate all docs from README.md, CLAUDE.md, man/backup.md into bible/
- Simplify CLAUDE.md to a single rule: read and respect the bible
- Simplify README.md to a brief intro with links to bible/
- Remove man/backup.md and pricelists_window.md (content migrated or obsolete)
- Fix API docs: add missing endpoints (preview-article, sync/repair),
  correct DELETE /api/projects/:uuid semantics (variant soft-delete only)
- Add Soft Deletes section to architecture doc (is_active pattern)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-02-20 14:15:52 +03:00

67 lines
2.2 KiB
Markdown

# QuoteForge
**Корпоративный конфигуратор серверов и расчёт КП**
Offline-first архитектура: пользовательские операции через локальную SQLite, MariaDB только для синхронизации.
![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)
---
## Документация
Полная архитектурная документация хранится в **[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 |
---
## Быстрый старт
```bash
# Применить миграции
go run ./cmd/qfs -migrate
# Запустить
go run ./cmd/qfs
# или
make run
```
Приложение: http://localhost:8080 → откроется `/setup` для настройки подключения к MariaDB.
```bash
# Сборка
make build-release
# Проверка
go build ./cmd/qfs && go vet ./...
```
---
## Releases & Changelog
Changelog между версиями: `releases/memory/v{major}.{minor}.{patch}.md`
---
## Поддержка
- Email: mike@mchus.pro
- Internal: @mchus
## Лицензия
Собственность компании, только для внутреннего использования. См. [LICENSE](LICENSE).