Add tomorrow handoff guide and update docs.
Create NEXT_STEPS file with concise restart plan and link it from README and technical specification. Made-with: Cursor
This commit is contained in:
@@ -0,0 +1,47 @@
|
|||||||
|
# Next Steps
|
||||||
|
|
||||||
|
Короткий файл "с чего начать завтра".
|
||||||
|
|
||||||
|
## 1) Подтянуть код на новом компьютере
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/PTah/nettopo-go.git
|
||||||
|
cd nettopo-go
|
||||||
|
```
|
||||||
|
|
||||||
|
## 2) Что открыть в первую очередь
|
||||||
|
|
||||||
|
- `README.md` - запуск и команды
|
||||||
|
- `TECH_SPEC.md` - статус задач с галочками
|
||||||
|
- `MANUAL_TEST_CHECKLIST.md` - пошаговая ручная приемка
|
||||||
|
|
||||||
|
## 3) Быстрый старт запуска
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cp .env.example .env
|
||||||
|
HTTP_ADDR=:8080 go run ./cmd/server
|
||||||
|
```
|
||||||
|
|
||||||
|
UI: `http://localhost:8080/`
|
||||||
|
|
||||||
|
## 4) Что проверить первым делом в UI
|
||||||
|
|
||||||
|
- создать scan по CIDR;
|
||||||
|
- дождаться завершения (`Ждать завершения`);
|
||||||
|
- загрузить topology;
|
||||||
|
- выполнить diff двух сканов;
|
||||||
|
- проверить фильтры/легенду;
|
||||||
|
- проверить экспорт JSON.
|
||||||
|
|
||||||
|
## 5) Главная цель на завтра
|
||||||
|
|
||||||
|
Пройти `MANUAL_TEST_CHECKLIST.md` полностью:
|
||||||
|
|
||||||
|
- Linux: PASS/FAIL
|
||||||
|
- Windows: PASS/FAIL
|
||||||
|
|
||||||
|
## 6) Если что-то сломается
|
||||||
|
|
||||||
|
- записать шаг из чек-листа, где проблема;
|
||||||
|
- сохранить текст ошибки;
|
||||||
|
- указать ОС и команду/действие, где воспроизводится.
|
||||||
@@ -20,6 +20,7 @@
|
|||||||
- Два backend-хранилища: in-memory и PostgreSQL.
|
- Два backend-хранилища: in-memory и PostgreSQL.
|
||||||
- После создания scan запускается фоновый discovery с обновлением статуса и прогресса.
|
- После создания scan запускается фоновый discovery с обновлением статуса и прогресса.
|
||||||
- Отдельный чек-лист ручной приемки: `MANUAL_TEST_CHECKLIST.md`.
|
- Отдельный чек-лист ручной приемки: `MANUAL_TEST_CHECKLIST.md`.
|
||||||
|
- План продолжения на завтра: `NEXT_STEPS.md`.
|
||||||
|
|
||||||
## Требования
|
## Требования
|
||||||
|
|
||||||
|
|||||||
@@ -57,6 +57,7 @@
|
|||||||
- [x] UI поддерживает экспорт topology/diff в JSON.
|
- [x] UI поддерживает экспорт topology/diff в JSON.
|
||||||
- [x] UI позволяет создать scan по CIDR и дождаться его завершения.
|
- [x] UI позволяет создать scan по CIDR и дождаться его завершения.
|
||||||
- [x] Подготовлен отдельный ручной чек-лист приемки (`MANUAL_TEST_CHECKLIST.md`).
|
- [x] Подготовлен отдельный ручной чек-лист приемки (`MANUAL_TEST_CHECKLIST.md`).
|
||||||
|
- [x] Подготовлен файл продолжения работы (`NEXT_STEPS.md`).
|
||||||
|
|
||||||
## Минимальные API
|
## Минимальные API
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user