Documentation Index
Fetch the complete documentation index at: https://docs.joinfindu.com/llms.txt
Use this file to discover all available pages before exploring further.
FindU Development Guide
This guide covers our development workflow, standards, and best practices for the FindU engineering team.Repository Overview
web_app
React dashboard for partners
- Partner analytics
- Messaging interface
- Profile management
- Scholarship tools
ios_app
Native iOS app for students
- College swiping
- Student messaging
- Profile creation
- Social features
matching-algorithm
ML matching engine
- Recommendation API
- Learning algorithms
- Performance optimization
- Mobile endpoints
data_scraping
Data collection & enrichment
- College data updates
- Image scraping
- AI-powered enhancements
- Automated pipelines
Development Process
1. Starting New Work
Check Current Sprint
- Review sprint board for assigned tasks
- Check with team lead for priorities
- Understand acceptance criteria
2. Making Changes
Always follow our branch strategy:Branch Protection Rules
Main Branch:- Requires PR from dev branch only
- Requires passing CI/CD checks
- No direct commits allowed
- Auto-deploys to production
- Requires PR from feature branches
- No approval required (trust-based)
- Direct commits allowed for hotfixes
- Auto-deploys to development environment
- No protection rules
- Should be deleted after merge
- Always created from dev
3. Code Standards
- TypeScript/React
- Swift/iOS
- Python
4. Manual Testing
Before submitting your PR:- Test your changes locally
- Verify the feature works as expected
- Check for console errors
- Test edge cases and error scenarios
- Verify mobile responsiveness (if web)
- Test on actual devices (if iOS)
5. Pull Request
Use our simplified PR template:Review Process
What happens after you open a PR:Code Review
Team members will review:
- Code quality and standards
- Architecture alignment
- Performance impact
- Security considerations
Manual Testing
- Test changes thoroughly locally
- Deploy to dev environment and test
- Check that existing features still work
- Mobile app: test on real devices
Team Communication
Daily Standup
Share progress and blockers
- What you completed
- What you’re working on
- Any blockers
Technical Help
Getting unstuck:
- Ask in #dev-help
- Pair with teammates
- Schedule 1:1 with lead
Design Decisions
For architecture questions:
- Document in PR
- Discuss in tech meeting
- Create ADR if needed
Sprint Planning
Weekly planning:
- Review upcoming work
- Estimate tasks
- Identify dependencies
Development Standards
Code Quality
- Write clean, readable code
- Add meaningful comments for complex logic
- Keep functions small and focused
- Follow DRY principles
Quality Assurance
- Test your changes thoroughly
- Try to break your own feature
- Test edge cases and error states
- Verify on different screen sizes
- Check performance impact
Documentation
- Update README for significant changes
- Document new APIs
- Keep CLAUDE.md files current
- Add inline documentation
Security
- Never commit secrets
- Follow security best practices
- Review dependencies
- Report vulnerabilities immediately
Deployment Process
Automated Deployment Pipeline
Environment Details
Development Environment
Branch:
dev- Auto-deploys on merge via Railway
- Development Supabase instance
- Testing ground for new features
- No approval required for deployment
- URL:
*-dev.railway.app
Production Environment
Branch:
main- Auto-deploys on merge via Railway
- Production Supabase instance (50k+ users)
- Live user traffic
- Requires PR review from dev branch
- URLs:
findu.app,*.railway.app
Remember: We’re building something amazing together. Quality over speed, communication over assumptions.