- Renamed auth-service to iam-service across various files for consistency. - Updated Dockerfiles, deployment configurations, and documentation to reflect the service name change. - Enhanced testing commands in documentation to point to the new iam-service. - Removed outdated auth-service files and configurations to streamline the project structure. - Improved bilingual documentation for clarity on the new service structure and usage.
1.6 KiB
1.6 KiB
New Developer Guide
Welcome to the GoodGo Microservices Platform team!
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
-
Clone the repository
git clone <repository-url> cd Base -
Run initialization script
./scripts/setup/init-project.sh -
Start local infrastructure
cd deployments/local docker-compose up -d -
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
- Ask in team Slack channel
- Review existing code examples
- Pair with senior developer
Next Steps
- Pick a small task from backlog
- Create feature branch
- Implement and test
- Create pull request
- Get code review
Good luck! 🚀