Development Guides
This section contains comprehensive guides for developers working on omegaUp.
Quick Links
-
Coding standards, style guides, and best practices for PHP, TypeScript, and Python.
-
How to write and run tests for PHP, TypeScript, and Cypress E2E tests.
-
Understanding DAO/VO patterns and database interaction best practices.
-
Vue.js component development and Storybook integration.
-
Common development commands and shortcuts.
Development Workflow
- Set up your environment - Get Docker running
- Read coding guidelines - Understand our standards
- Write tests - Ensure your code works
- Submit a PR - Contribute your changes
Key Principles
Type Safety
- All code must declare data types
- TypeScript for frontend
- Psalm for PHP
- mypy for Python
Testing
- All functionality changes must include tests
- Tests must pass 100% before committing
- Write tests first when possible
Code Quality
- Follow automated linting rules
- Use guard clauses instead of nested conditionals
- Minimize null/undefined usage
- Remove unused code (don't comment it out)
Related Documentation
- Architecture Overview - System design
- API Reference - API documentation
- Getting Started - Setup and contribution guide
Ready to code? Start with Coding Guidelines!