Files
agentic-soc-platform/backend/readme.md
T

49 lines
1.2 KiB
Markdown
Raw Normal View History

2026-06-27 19:08:48 +08:00
# ASP Backend
2026-07-05 17:29:22 +08:00
Django backend for Agentic SOC Platform.
2026-06-27 19:08:48 +08:00
2026-07-05 17:29:22 +08:00
## Development
2026-06-27 19:08:48 +08:00
2026-07-05 17:29:22 +08:00
Run commands from the `backend` directory:
2026-06-27 19:08:48 +08:00
```powershell
2026-07-05 17:29:22 +08:00
uv sync
.\.venv\Scripts\python.exe manage.py migrate
.\.venv\Scripts\python.exe manage.py runserver
2026-06-27 19:08:48 +08:00
```
2026-07-05 17:29:22 +08:00
For websocket development, also run the ASGI server:
2026-06-27 19:08:48 +08:00
2026-07-05 17:29:22 +08:00
```powershell
.\.venv\Scripts\python.exe -m uvicorn asp.asgi:application --host 127.0.0.1 --port 8001
```
Run the dashboard cache worker in another terminal so dashboard snapshots stay available:
```powershell
.\.venv\Scripts\python.exe manage.py run_dashboard_cache_worker
```
2026-07-05 17:29:22 +08:00
## Admin user
ASP admin users are Django superusers and are maintained from the backend command line:
2026-06-27 19:08:48 +08:00
```powershell
.\.venv\Scripts\python.exe manage.py createsuperuser
.\.venv\Scripts\python.exe manage.py changepassword <admin-username>
```
2026-07-05 17:29:22 +08:00
## Documentation
2026-06-27 19:08:48 +08:00
2026-07-05 17:29:22 +08:00
Product, deployment, and operations documentation lives in the docs site:
2026-06-27 19:08:48 +08:00
2026-07-05 17:29:22 +08:00
- https://asp.viperrtp.com/asp/quick-start/deployment/
- https://asp.viperrtp.com/asp/quick-start/first-login/
- https://asp.viperrtp.com/asp/settings/users/
2026-07-22 15:09:34 +08:00
Runtime API documentation is served by the backend:
- Swagger UI: `/api/docs/`
- Redoc: `/api/redoc/`
- OpenAPI schema: `/api/schema/`