feat(docs): Added a section about the development workflow using SFTP

This commit is contained in:
Divarion-D
2026-04-07 15:57:55 +03:00
parent a4e5a719df
commit c8a30b657d
4 changed files with 122 additions and 0 deletions

View File

@@ -21,6 +21,7 @@
- [🖥 CLI Tools & DB Migrations](en-us/development/cli-tools.md)
- [⚙️ Autoloader & Class Registration](en-us/development/autoloader.md)
- [🧩 Module System](en-us/development/modules.md)
- [📂 Development Workflow (SFTP)](en-us/development/dev-workflow.md)
- 📦 **Additional**
- [🎬 Watchfolder](en-us/info/watch_folder.md)

View File

@@ -0,0 +1,60 @@
# Development Workflow
## Deploying Code to VDS via SFTP
For daily development, we recommend the [SFTP extension](https://marketplace.visualstudio.com/items?itemName=Natizyskunk.sftp) for VS Code — edit locally, auto-upload on save.
### Setup
Create `.vscode/sftp.json`:
```json
[
{
"name": "My Dev VDS",
"host": "YOUR_VDS_IP",
"protocol": "sftp",
"port": 22,
"username": "root",
"remotePath": "/home/xc_vm",
"useTempFile": false,
"uploadOnSave": true,
"openSsh": false,
"watcher": {
"files": "**/*",
"autoUpload": false,
"autoDelete": true
},
"ignore": [
".vscode",
".git",
".gitattributes",
".gitignore",
"update",
"*pycache/",
"*.gitkeep",
"bin/",
"config/",
"tmp/"
],
"context": "./src/",
"profiles": {}
}
]
```
### Key Settings
- **`context: "./src/"`** — maps local `src/` to remote `/home/xc_vm/`
- **`uploadOnSave: true`** — every Ctrl+S pushes the file to VDS instantly
- **`ignore`** — protects server-specific files (`bin/`, `config/`, `tmp/`)
> **Security:** Use SSH keys instead of password. The `.vscode/` directory is in `.gitignore`, so credentials won't leak to git.
### Workflow
1. Open project in VS Code
2. Edit any file under `src/`
3. Save — file is automatically uploaded to VDS
4. Test on VDS
5. Commit to git as usual

View File

@@ -21,6 +21,7 @@
- [🖥 CLI-инструменты и миграции БД](ru-ru/development/cli-tools.md)
- [⚙️ Автозагрузчик и регистрация классов](ru-ru/development/autoloader.md)
- [🧩 Система модулей](ru-ru/development/modules.md)
- [📂 Рабочий процесс (SFTP)](ru-ru/development/dev-workflow.md)
- 📦 **Дополнительно**
- [🎬 Watchfolder](ru-ru/info/watch_folder.md)

View File

@@ -0,0 +1,60 @@
# Рабочий процесс разработки
## Деплой кода на VDS через SFTP
Для ежедневной разработки рекомендуем [расширение SFTP](https://marketplace.visualstudio.com/items?itemName=Natizyskunk.sftp) для VS Code — редактируете локально, файлы автоматически загружаются при сохранении.
### Настройка
Создайте `.vscode/sftp.json`:
```json
[
{
"name": "My Dev VDS",
"host": "IP_ВАШЕГО_VDS",
"protocol": "sftp",
"port": 22,
"username": "root",
"remotePath": "/home/xc_vm",
"useTempFile": false,
"uploadOnSave": true,
"openSsh": false,
"watcher": {
"files": "**/*",
"autoUpload": false,
"autoDelete": true
},
"ignore": [
".vscode",
".git",
".gitattributes",
".gitignore",
"update",
"*pycache/",
"*.gitkeep",
"bin/",
"config/",
"tmp/"
],
"context": "./src/",
"profiles": {}
}
]
```
### Ключевые настройки
- **`context: "./src/"`** — маппит локальную `src/` на удалённую `/home/xc_vm/`
- **`uploadOnSave: true`** — каждый Ctrl+S мгновенно загружает файл на VDS
- **`ignore`** — защищает серверо-специфичные файлы (`bin/`, `config/`, `tmp/`)
> **Безопасность:** Используйте SSH-ключи вместо пароля. Директория `.vscode/` находится в `.gitignore`, поэтому креды не попадут в git.
### Рабочий процесс
1. Открываете проект в VS Code
2. Редактируете любой файл в `src/`
3. Сохраняете — файл автоматически загружается на VDS
4. Тестируете на VDS
5. Коммитите в git как обычно