Skip to content

Commit 2456c70

Browse files
authored
doc(README): add description
1 parent 0a65d23 commit 2456c70

File tree

1 file changed

+25
-2
lines changed

1 file changed

+25
-2
lines changed

README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,25 @@
1-
# APPNANE_SNAKE_CASE
2-
kebab-case > snake_case
1+
# appname_kebab_case
2+
Что бы начать, замените в названиях и содержаниях всех файлах:
3+
1. `appname_kebab_case` - на название вашего приложение в [kebab-case](https://developer.mozilla.org/en-US/docs/Glossary/Kebab_case)
4+
2. `appname_snake_case` - на название вашего приложение в [snake_case](https://developer.mozilla.org/en-US/docs/Glossary/Snake_case)
5+
6+
После замените это описание на описание вашего appname_kebab_case.
7+
8+
## Развертывание для разработки
9+
```bash
10+
git clone https://github.com/emptybutton/appname_kebab_case.git
11+
docker compose -f appname_kebab_case/deployments/dev/docker-compose.yaml up
12+
```
13+
14+
В контейнере используется своё виртуальное окружение, сохранённое отдельным volume-ом, поэтому можно не пересобирать образ при изменении зависимостей.
15+
16+
Для ide можно сделать отдельное виртуальное окружение в папке проекта:
17+
```bash
18+
uv sync --extra dev --directory test-cash-register
19+
```
20+
21+
> [!NOTE]
22+
> При изменении зависимостей в одном окружении необходимо синхронизировать другое с первым:
23+
> ```bash
24+
> uv sync --extra dev
25+
> ```

0 commit comments

Comments
 (0)