Skip to content

4_development

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

4_development

README.md

Development Guides & Workflows

Version: 1.0.0
Last Updated: December 3, 2025
Status: Published
Audience: Developers (Backend, Frontend, Full-Stack)

Purpose

This section contains coding practices, development workflows, setup guides, and implementation documentation for IoT Bay contributors.

Documentation Files

Document Purpose For Whom
BACKEND_GUIDE.md Java/Servlet/DAO patterns and best practices Backend Developers
FRONTEND_GUIDE.md JSP/TypeScript/CSS patterns Frontend Developers
CODE_STYLE.md Coding standards & conventions All Developers
GIT_WORKFLOW.md Branching & commit strategy All Developers
CONTRIBUTING.md How to contribute Contributors
API_DOCUMENTATION.en_docs.md Extended API reference documentation Backend Devs
COLOR_REFACTORING_GUIDE.en_docs.md KickoffLabs-based design optimization (494 lines) Frontend Devs, Designers
JSP_DEVELOPER_DOCUMENTATION.en_docs.md Backend JSP/Servlet implementation patterns (56K chars) Backend Developers
UI_UX_DOCUMENTATION.en_docs.md Frontend implementation patterns (208K chars) Frontend Developers
TYPESCRIPT_MIGRATION.md TypeScript migration strategy Frontend Developers
deployment/ Deployment guides and procedures DevOps, Developers

Note: .en_docs.md files contain specialized implementation details and multilingual content complementing standard guides.

Quick Start Paths

For Backend Developers

  1. Read BACKEND_GUIDE.md
  2. Review CODE_STYLE.md
  3. Check GIT_WORKFLOW.md
  4. Deep dive: JSP_DEVELOPER_DOCUMENTATION.en_docs.md

For Frontend Developers

  1. Read FRONTEND_GUIDE.md
  2. Review CODE_STYLE.md
  3. Check GIT_WORKFLOW.md
  4. Deep dive: UI_UX_DOCUMENTATION.en_docs.md
  5. Design system: COLOR_REFACTORING_GUIDE.en_docs.md

For New Contributors

  1. Start with CONTRIBUTING.md
  2. Set up Git workflow: GIT_WORKFLOW.md
  3. Learn code standards: CODE_STYLE.md
  4. Pick your path: BACKEND_GUIDE.md or FRONTEND_GUIDE.md

Development Workflow

1. Clone Repository
   ↓
2. Create Feature Branch (git checkout -b feature/your-feature)
   ↓
3. Write Code (following CODE_STYLE.md)
   ↓
4. Write Tests
   ↓
5. Commit Changes (following GIT_WORKFLOW.md)
   ↓
6. Push & Create Pull Request
   ↓
7. Code Review & Merge

See GIT_WORKFLOW.md for detailed workflow documentation.

Document Structure

This section contains 11 files organized into:

  • 2 core development guides (backend, frontend)
  • 3 workflow documents (code style, Git, contributing)
  • 4 specialized implementation guides (.en_docs.md)
  • 2 migration/future planning docs
  • 1 deployment subdirectory

Related Documentation

Version: 1.0.0
Status: Published
Last Updated: December 3, 2025
Maintained By: IoT Bay Documentation Team

Document Version: 1.0.0