🔁 Synticore Website Compiler - Workflow

🎯 Purpose

This page provides practical, repeatable workflows for common day-to-day and release tasks.

🆕 First-Time Project Setup Workflow

1. Install dependencies at compiler root:

npm install
pip install -r requirements.txt

2. Select project (GUI or config/settings.json -> dir_recent[0]).
3. Validate environment:

npm run gulp about

4. Run initial build:

npm run gulp build

🔁 Daily Local Development Workflow

Use watch mode for active development:

npm run gulp watch

Typical loop:

1. Edit source files under <project>/in/
2. Let watch rebuild affected assets/pages (including dependency-triggered tasks when a referenced file changes or is deleted)
3. Verify output in browser
4. Repeat

If behavior looks stale:

npm run gulp rebuild

🧩 Config-Change Workflow

When changing config.json or schema behavior:

npm run gulp sort_config
npm run gulp build_config
npm run gulp build

If needed, force clean config refresh:

npm run gulp rebuild_config

🎯 Asset-Focused Workflow (Fast Targeted Rebuilds)

Use scoped rebuild tasks to keep feedback fast:

npm run gulp rebuild_stylesheet
npm run gulp rebuild_javascript
npm run gulp rebuild_image

Other common targets:

• rebuild_html
• rebuild_font_icon
• rebuild_favicon
• rebuild_mirror

📦 Release Packaging Workflow

1. Run clean full build:

npm run gulp reset
npm run gulp build

2. Produce package outputs:

npm run gulp package

3. Collect artifacts from project _package/ (and/or configured package outputs).

🧭 Migration Workflow (Older Project To Current Compiler)

1. Back up project directory.
2. Check version state:

npm run gulp about

3. Run migration:

npm run gulp project_update_full

4. Validate:

npm run gulp build
npm run gulp package

For custom migration range testing:

npm run gulp project_update_directed

🧯 Incident/Debug Workflow

1. Reproduce with explicit task command.
2. Read logs in this order:
   • <project>/_log/task_<task>.log
   • <compiler>/_log/gulpfile.log
   • <compiler>/_log/gui.log (if GUI involved)
3. Run baseline checks:

npm run gulp about
npm run gulp rebuild

4. If still unresolved, capture logs + config excerpt and file an issue.

⚡ Command Quick Sheet

# General
npm run gulp about
npm run gulp build
npm run gulp watch
npm run gulp browser
npm run gulp plan
npm run gulp package

# Clean/Rebuild
npm run gulp reset
npm run gulp rebuild

# Migration
npm run gulp project_update_full
npm run gulp project_update_directed