You've already forked RekomenciBackend
add readme.md
This commit is contained in:
@@ -0,0 +1,59 @@
|
||||
# Rekomenci fluon *(рэкоменси флюйон)*
|
||||
|
||||
## **Кейс — сколько ты зарабатываешь?**
|
||||
|
||||
## Для продактов
|
||||
|
||||
Пока хз что написать
|
||||
|
||||
|
||||
## Для разработчиков
|
||||
|
||||
[RFC проекта](RFC.md)
|
||||
|
||||
### Быстрый старт
|
||||
|
||||
1. Установка зависимостей
|
||||
```shell
|
||||
uv sync --group dev
|
||||
```
|
||||
|
||||
2. Запуск линтеров
|
||||
```shell
|
||||
just lint
|
||||
```
|
||||
|
||||
3. Запуск проекта
|
||||
```shell
|
||||
just build
|
||||
just up
|
||||
```
|
||||
|
||||
4. Создание и применение миграций
|
||||
```shell
|
||||
just migrations-make "message"
|
||||
just migrations-run
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Стек
|
||||
|
||||
#### Backend
|
||||
|
||||
+ **fastapi** - http server
|
||||
+ **dishka** - IoC container
|
||||
+ **sqlalchemy** - ORM и query builder
|
||||
+ **adaptix** и **pydantic** - для моделей
|
||||
+ **postgresql** - база данных
|
||||
|
||||
#### ML
|
||||
|
||||
+ **torch** - для машинного обучения
|
||||
+ **sentence-transformers** - создание эмбеддингов
|
||||
|
||||
#### Linters
|
||||
+ **mypy strict** - статический анализатор типов
|
||||
+ **ruff** - статический линтер и форматтер кода
|
||||
+ **codespell** - сыщик опечаток
|
||||
+ **bandit** - сыщик уязвимостей
|
||||
|
||||
Reference in New Issue
Block a user