Skip to content

Docs: add Windows quick start and .env troubleshooting#1485

Draft
anushkakedari wants to merge 1 commit intoOWASP:mainfrom
anushkakedari:docs/windows-quickstart
Draft

Docs: add Windows quick start and .env troubleshooting#1485
anushkakedari wants to merge 1 commit intoOWASP:mainfrom
anushkakedari:docs/windows-quickstart

Conversation

@anushkakedari
Copy link

Summary

  • Add a “Quick start (Windows, local development)” section to README.md.
  • Document a simple local setup flow using minimal.env → .env and the existing dev:server / dev:vue scripts.
  • Add a “Troubleshooting (common startup issues)” section covering:
  • ENCRYPTION_KEYS is a required property, Threat Dragon server cannot start without it
  • Unable to find .env file, falling back to environment variables

Motivation

  • When setting up the project on Windows, I ran into startup failures because .env and ENCRYPTION_KEYS were not configured.
  • These changes make the local development setup clearer and help new contributors quickly fix the most common env-related errors.

Notes

  • Documentation-only change: no code or behavior modifications.
  • Tested by starting the backend (npm run dev:server) and frontend (npm run dev:vue) with the documented steps and confirming the app loads at http://localhost:8080/.

@jgadsden jgadsden marked this pull request as draft March 9, 2026 20:39
Copy link
Collaborator

@jgadsden jgadsden left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hello @anushkakedari , please follow the 'Contributing to OWASP Threat Dragon' guidelines

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants