From fec542a275ed6c8273bb253ca4b58a497f74cd99 Mon Sep 17 00:00:00 2001 From: Sergey Krylov Date: Mon, 24 Aug 2026 10:29:00 +0300 Subject: [PATCH] docs: refresh backend onboarding --- AGENTS.md | 1 + README.md | 123 +++++++++++++----------------------------------------- 2 files changed, 31 insertions(+), 93 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index b561cce..c9e917f 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -23,6 +23,7 @@ Prisma schema-engine failure; статус и trigger пересмотра ук ## Границы +- Перед изменением поставленного поведения или доменных терминов прочитать [`../docs/architecture/system-overview.md`](../docs/architecture/system-overview.md) и [`../docs/architecture/domain-glossary.md`](../docs/architecture/domain-glossary.md). - Публичный HTTP API версионируется как `/api/v1`; OpenAPI из backend - источник контракта для frontend. - Backend отвечает за доменную логику, данные, конфигурацию и внешние интеграции. Frontend не вызывает T-Bank напрямую; будущая интеграция остается за backend boundary. - Не размещать frontend-код, сгенерированный клиент или постоянную документацию в этом репозитории. diff --git a/README.md b/README.md index 9f1d965..20085ef 100644 --- a/README.md +++ b/README.md @@ -1,113 +1,50 @@ -

- Nest Logo -

+# WealthLedger backend -[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456 -[circleci-url]: https://circleci.com/gh/nestjs/nest +NestJS API WealthLedger. Backend владеет auth, SQLite-данными и server-side +интеграцией T-Bank; frontend не обращается к T-Bank напрямую. -

A progressive Node.js framework for building efficient and scalable server-side applications.

-

-NPM Version -Package License -NPM Downloads -CircleCI -Discord -Backers on Open Collective -Sponsors on Open Collective - Donate us - Support us - Follow us on Twitter -

- +## Быстрый старт -## WealthLedger backend - -NestJS API WealthLedger. Требуется Node 22. Перед первой локальной проверкой -установите зависимости строго из lockfile: +Требуется Node 22 (`.nvmrc`). Создайте `.env` из примера, замените placeholder +секреты и установите зависимости строго из lockfile: ```bash +cp .env.example .env npm ci +npm run start:dev ``` -Проверки, не изменяющие исходники: +`JWT_SECRET` должен быть секретом не короче 32 символов, а +`TOKEN_ENCRYPTION_KEY` — base64-кодированным 32-байтным ключом. Не добавляйте +T-Bank token в `.env`: он вводится пользователем и хранится в зашифрованном +виде. + +## Проверка + +Следующие команды не изменяют исходные файлы: ```bash npm run lint npm run typecheck:app npm run typecheck:test +npm test -- --runInBand ``` -Для явного исправления форматирования используйте `npm run lint:fix`. -`npm run test:e2e` пока не является надёжным local gate: Prisma 7.9.1 -останавливает migration до Jest; запись WL-P2-05 в -`../docs/development/audit-remediation.md` фиксирует rationale и trigger -пересмотра. +`npm run lint:fix` — явная команда автоисправления. `npm run test:e2e` пока не +является passing gate: Prisma schema engine останавливает migration до запуска +Jest. Точный статус и trigger пересмотра находятся в +[remediation registry](../docs/development/audit-remediation.md). -## Запуск приложения +## Документация -## Compile and run the project +- [Backend workflow](../docs/development/backend-workflow.md) +- [API contract и runtime OpenAPI](../docs/development/runtime-openapi-verification.md) +- [Обзор поставленной системы](../docs/architecture/system-overview.md) +- [Архитектурные решения](../docs/adr/README.md) +- [Remediation registry](../docs/development/audit-remediation.md) + +Из workspace runtime OpenAPI можно read-only сверить с frontend snapshot: ```bash -# development -$ npm run start - -# watch mode -$ npm run start:dev - -# production mode -$ npm run start:prod +bash specs/scripts/verify-runtime-openapi.sh ``` - -## Run tests - -```bash -# unit tests -$ npm run test - -# e2e tests -$ npm run test:e2e - -# test coverage -$ npm run test:cov -``` - -## Deployment - -When you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the [deployment documentation](https://docs.nestjs.com/deployment) for more information. - -If you are looking for a cloud-based platform to deploy your NestJS application, check out [Mau](https://mau.nestjs.com), our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps: - -```bash -$ npm install -g @nestjs/mau -$ mau deploy -``` - -With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure. - -## Resources - -Check out a few resources that may come in handy when working with NestJS: - -- Visit the [NestJS Documentation](https://docs.nestjs.com) to learn more about the framework. -- For questions and support, please visit our [Discord channel](https://discord.gg/G7Qnnhy). -- To dive deeper and get more hands-on experience, check out our official video [courses](https://courses.nestjs.com/). -- Deploy your application to AWS with the help of [NestJS Mau](https://mau.nestjs.com) in just a few clicks. -- Visualize your application graph and interact with the NestJS application in real-time using [NestJS Devtools](https://devtools.nestjs.com). -- Need help with your project (part-time to full-time)? Check out our official [enterprise support](https://enterprise.nestjs.com). -- To stay in the loop and get updates, follow us on [X](https://x.com/nestframework) and [LinkedIn](https://linkedin.com/company/nestjs). -- Looking for a job, or have a job to offer? Check out our official [Jobs board](https://jobs.nestjs.com). - -## Support - -Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support). - -## Stay in touch - -- Author - [Kamil Myśliwiec](https://twitter.com/kammysliwiec) -- Website - [https://nestjs.com](https://nestjs.com/) -- Twitter - [@nestframework](https://twitter.com/nestframework) - -## License - -Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE).