pos-system/docs/en/onboarding/new-developer-guide.md

New Developer Guide

Welcome to VelikHo's Microservices Platform project!

First Day Checklist

• Access to GitHub repository
• Access to development environment
• Docker installed and running
• Node.js and PNPM installed
• IDE configured (VS Code recommended)
• Read this guide

Setup Your Development Environment

1. Clone the repository

   git clone <repository-url>
   cd Base
   

2. Run initialization script

   ./scripts/setup/init-project.sh
   

3. Start local infrastructure

   cd deployments/local
   docker-compose up -d
   

4. Verify setup

   • Check Traefik: http://localhost:8080
   • Check API: http://localhost/api/v1/health

Development Tools

Recommended VS Code Extensions

• ESLint
• Prettier
• Prisma
• Docker
• GitLens

Useful Commands

# Start all services
./scripts/dev/start-all.sh

# Start specific service
./scripts/dev/start-service.sh iam-service

# View logs
./scripts/dev/logs.sh iam-service

# Run migrations
./scripts/db/migrate.sh iam-service dev

# Run tests
pnpm test

Code Standards

• TypeScript: Strict mode enabled
• Linting: ESLint with shared config
• Formatting: Prettier
• Commits: Conventional Commits format
• Tests: Minimum 80% coverage

Getting Help

• Check Documentation
• Contact maintainer: hongochai10@icloud.com
• Review existing code examples
• Open an issue on GitHub

Next Steps

1. Pick a small task from backlog
2. Create feature branch
3. Implement and test
4. Create pull request
5. Get code review

Good luck! 🚀