docs: refresh backend onboarding
This commit is contained in:
@@ -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.
|
- Публичный HTTP API версионируется как `/api/v1`; OpenAPI из backend - источник контракта для frontend.
|
||||||
- Backend отвечает за доменную логику, данные, конфигурацию и внешние интеграции. Frontend не вызывает T-Bank напрямую; будущая интеграция остается за backend boundary.
|
- Backend отвечает за доменную логику, данные, конфигурацию и внешние интеграции. Frontend не вызывает T-Bank напрямую; будущая интеграция остается за backend boundary.
|
||||||
- Не размещать frontend-код, сгенерированный клиент или постоянную документацию в этом репозитории.
|
- Не размещать frontend-код, сгенерированный клиент или постоянную документацию в этом репозитории.
|
||||||
|
|||||||
@@ -1,113 +1,50 @@
|
|||||||
<p align="center">
|
# WealthLedger backend
|
||||||
<a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="120" alt="Nest Logo" /></a>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
|
NestJS API WealthLedger. Backend владеет auth, SQLite-данными и server-side
|
||||||
[circleci-url]: https://circleci.com/gh/nestjs/nest
|
интеграцией T-Bank; frontend не обращается к T-Bank напрямую.
|
||||||
|
|
||||||
<p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
|
## Быстрый старт
|
||||||
<p align="center">
|
|
||||||
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
|
|
||||||
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
|
|
||||||
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
|
|
||||||
<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
|
|
||||||
<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
|
|
||||||
<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
|
|
||||||
<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
|
|
||||||
<a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg" alt="Donate us"/></a>
|
|
||||||
<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
|
|
||||||
<a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow" alt="Follow us on Twitter"></a>
|
|
||||||
</p>
|
|
||||||
<!--[](https://opencollective.com/nest#backer)
|
|
||||||
[](https://opencollective.com/nest#sponsor)-->
|
|
||||||
|
|
||||||
## WealthLedger backend
|
Требуется Node 22 (`.nvmrc`). Создайте `.env` из примера, замените placeholder
|
||||||
|
секреты и установите зависимости строго из lockfile:
|
||||||
NestJS API WealthLedger. Требуется Node 22. Перед первой локальной проверкой
|
|
||||||
установите зависимости строго из lockfile:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
cp .env.example .env
|
||||||
npm ci
|
npm ci
|
||||||
|
npm run start:dev
|
||||||
```
|
```
|
||||||
|
|
||||||
Проверки, не изменяющие исходники:
|
`JWT_SECRET` должен быть секретом не короче 32 символов, а
|
||||||
|
`TOKEN_ENCRYPTION_KEY` — base64-кодированным 32-байтным ключом. Не добавляйте
|
||||||
|
T-Bank token в `.env`: он вводится пользователем и хранится в зашифрованном
|
||||||
|
виде.
|
||||||
|
|
||||||
|
## Проверка
|
||||||
|
|
||||||
|
Следующие команды не изменяют исходные файлы:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm run lint
|
npm run lint
|
||||||
npm run typecheck:app
|
npm run typecheck:app
|
||||||
npm run typecheck:test
|
npm run typecheck:test
|
||||||
|
npm test -- --runInBand
|
||||||
```
|
```
|
||||||
|
|
||||||
Для явного исправления форматирования используйте `npm run lint:fix`.
|
`npm run lint:fix` — явная команда автоисправления. `npm run test:e2e` пока не
|
||||||
`npm run test:e2e` пока не является надёжным local gate: Prisma 7.9.1
|
является passing gate: Prisma schema engine останавливает migration до запуска
|
||||||
останавливает migration до Jest; запись WL-P2-05 в
|
Jest. Точный статус и trigger пересмотра находятся в
|
||||||
`../docs/development/audit-remediation.md` фиксирует rationale и 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
|
```bash
|
||||||
# development
|
bash specs/scripts/verify-runtime-openapi.sh
|
||||||
$ npm run start
|
|
||||||
|
|
||||||
# watch mode
|
|
||||||
$ npm run start:dev
|
|
||||||
|
|
||||||
# production mode
|
|
||||||
$ npm run start:prod
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## 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).
|
|
||||||
|
|||||||
Reference in New Issue
Block a user