Skip to main content

Team Training Guide

A comprehensive training program for onboarding and upskilling development teams on the Ever Works platform.

🎯 Training Objectives​

By completing this training program, team members will be able to:

  • ✅ Set up and configure their development environment
  • ✅ Understand the Ever Works architecture and tech stack
  • ✅ Follow established coding standards and conventions
  • ✅ Document APIs using the automated documentation system
  • ✅ Implement features following best practices
  • ✅ Debug and troubleshoot common issues
  • ✅ Contribute to the codebase confidently

📚 Training Modules​

1. Onboarding​

Duration: 1-2 days
Target: New team members

Learn how to set up your development environment, understand the project structure, and make your first contribution.

Topics covered:

  • Environment setup and configuration
  • Project structure overview
  • First deployment
  • Development workflow
  • Git conventions

2. API Documentation​

Duration: 2-3 days
Target: All developers working on API endpoints

Master the automated API documentation system using Swagger annotations and Scalar UI.

Topics covered:

  • Swagger annotation syntax
  • Standardized tag conventions
  • Documentation generation workflow
  • Quality standards
  • Troubleshooting common issues

3. Best Practices​

Duration: 1-2 days
Target: All team members

Learn the coding standards, patterns, and best practices used in Ever Works.

Topics covered:

  • TypeScript best practices
  • React patterns and optimization
  • Database best practices
  • Security guidelines
  • Performance optimization

4. Hands-On Exercises​

Duration: 3-5 days
Target: All team members

Practice what you've learned with real-world exercises and challenges.

Topics covered:

  • Simple GET route implementation
  • POST route with validation
  • Complete feature implementation
  • Code review exercises

📅 Training Timeline​

New Team Members (2 weeks)​

Week 1: Foundation

Week 2: Practice

Existing Team Members (3-5 days)​

Refresher Training

📋 Prerequisites​

Required Knowledge​

  • JavaScript/TypeScript: Intermediate to advanced
  • React: Solid understanding of hooks, components, state management
  • Next.js: Basic familiarity (App Router preferred)
  • Git: Version control basics
  • REST APIs: HTTP methods, status codes, JSON
  • PostgreSQL: Basic SQL queries
  • Tailwind CSS: Utility-first CSS
  • Drizzle ORM: Type-safe database queries
  • OAuth: Authentication flows
  • Stripe/Payment APIs: Payment processing

Tools to Install​

Before starting the training, ensure you have:

  • Node.js 20.19.0+ (use nvm)
  • pnpm (install) -- the monorepo package manager
  • PostgreSQL 14+
  • Git
  • VS Code (or preferred IDE)

Recommended VS Code Extensions:

  • ESLint
  • Prettier
  • Tailwind CSS IntelliSense
  • Swagger Viewer
  • REST Client
  • Error Lens

🎓 Certification​

Upon completing the training program, team members should be able to:

  • Set up the development environment independently
  • Create and document API endpoints following standards
  • Implement features using established patterns
  • Write clean, maintainable, and performant code
  • Debug issues using available tools
  • Pass code reviews consistently

📖 Additional Resources​

Internal Documentation​

External Resources​

🆘 Getting Help​

During Training:

  • Ask your mentor or team lead
  • Check the Quick Reference
  • Review relevant documentation sections

After Training:

  • Team Slack channels
  • Code review feedback
  • Weekly team meetings
  • Pair programming sessions

Next Steps​

Ready to start? Begin with the Onboarding module! 🚀