Complete documentation for the AutoPWN security testing platform.
- README - Project overview and quick start
- SETUP - Initial setup and installation guide
- DEVELOPMENT - Development environment and workflow
- ARCHITECTURE - System architecture and component overview
- DATABASE - Database schema and design
- API - API endpoints and usage
- BETTER_AUTH_SCHEMA - Authentication system schema
- DEPLOYMENT - General deployment guide
- DOCKER_DEPLOYMENT - Docker deployment (dev, test, prod)
- DOCKER_FILES_OVERVIEW - Docker Compose files explained
- REDIS_CONFIGURATION - Redis setup and security
- TESTING - Testing overview and strategy
- NEW_TESTING_GUIDE - Modern testing infrastructure
- TEST_COVERAGE - Coverage requirements and best practices
- EMAIL_VERIFICATION - Email verification setup (SMTP, Mailhog)
- PROJECT_PLAN - Project planning and milestones
- ROADMAP - Feature roadmap and future plans
Start here if you're new to the project:
- SETUP.md - Get your development environment running
- DEVELOPMENT.md - Learn the development workflow
- TESTING.md - Run and write tests
- DOCKER_FILES_OVERVIEW.md - Understand Docker setup
Deploying to production:
- DOCKER_DEPLOYMENT.md - Complete deployment guide
- REDIS_CONFIGURATION.md - Redis security hardening
- EMAIL_VERIFICATION.md - Configure email service
Contributing to the project:
- ARCHITECTURE.md - Understand the system design
- DATABASE.md - Database schema and migrations
- API.md - API structure and conventions
- TEST_COVERAGE.md - Testing requirements
- Initial setup steps
- Dependencies and requirements
- Environment configuration
- Database initialization
- Local development workflow
- Hot reload setup
- Debugging tips
- Code style and conventions
- System components
- Data flow
- Security design
- Technology stack
- Unit testing
- Integration testing
- E2E testing
- Test coverage requirements
- CI/CD integration
- Docker environments (dev, test, staging, prod)
- Environment variables
- Security hardening
- Monitoring and logging
- Backup and recovery
- Redis configuration
- Database tuning
- Email setup
- Authentication configuration
| Topic | Documentation |
|---|---|
| Getting Started | SETUP.md, DEVELOPMENT.md |
| Docker | DOCKER_DEPLOYMENT.md, DOCKER_FILES_OVERVIEW.md |
| Testing | TESTING.md, TEST_COVERAGE.md, NEW_TESTING_GUIDE.md |
| Database | DATABASE.md, BETTER_AUTH_SCHEMA.md |
| Security | REDIS_CONFIGURATION.md, EMAIL_VERIFICATION.md |
| API | API.md |
| Deployment | DEPLOYMENT.md, DOCKER_DEPLOYMENT.md |
| I want to... | Read this |
|---|---|
| Set up my development environment | SETUP.md |
| Run the application locally | DEVELOPMENT.md |
| Run tests | TESTING.md |
| Deploy to production | DOCKER_DEPLOYMENT.md |
| Configure Redis | REDIS_CONFIGURATION.md |
| Set up email verification | EMAIL_VERIFICATION.md |
| Understand the architecture | ARCHITECTURE.md |
| Work with the database | DATABASE.md |
| Understand Docker setup | DOCKER_FILES_OVERVIEW.md |
All documentation in this project follows these standards:
- Clear Structure - Each document has a table of contents and clear sections
- Code Examples - Practical examples for all commands and configurations
- Version Control - Docs include "Last Updated" date at the bottom
- Cross-References - Links between related documentation
- Troubleshooting - Common issues and solutions included where applicable
When making changes to the project:
- Update relevant docs - If you change functionality, update the documentation
- Check cross-references - Ensure links still work
- Update dates - Change the "Last Updated" date at the bottom of modified docs
- Test examples - Verify code examples still work
Older or superseded documentation is kept in docs/archive/ for historical reference.
If you can't find what you're looking for:
- Check the README in the project root
- Search all documentation:
grep -r "your search term" docs/ - Check the TROUBLESHOOTING guide
- Ask in project discussions or issues
Last Updated: 2025-10-24 Total Documentation Files: 17