Skip to content

A simple script to make folders pre-numbered and organized from the start, designed for use with Synchthing and Open Media Vault.

License

Notifications You must be signed in to change notification settings

daurydicaprio/project-generator-syncthing

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

2 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸš€ Project Generator for Syncthing Creative Workflow

Author: Daury DiCaprio β€” daurydicaprio.com
#VERyGoodforlife


🎯 Purpose

This project is a Project Generator designed to create a minimal, intuitive, and KISS-based folder structure for creative workflows.
It is especially tailored for content creators working with videos, articles, podcasts, and newsletters, and integrates seamlessly with Syncthing for multi-device synchronization.

The generator automatically creates:

  • Organized folder hierarchy
  • Templates for each content type
  • A manual with workflow guidance
  • A base .stignore for safe synchronization

πŸ“‚ Folder Structure

00_resources/ ← Shared resources, templates, manuals β”œβ”€ graphics/ β”œβ”€ music/ β”œβ”€ others/ β”œβ”€ templates/ └─ READ_THE_MANUAL_HERE.md

01_videos/ ← Active video projects (full-length and shorts) 02_articles/ ← Active article projects 03_podcasts/ ← Active podcast projects 04_newsletter/ ← Active newsletter projects 05_review/ ← Optional review folder (receive-only) 06_final/ ← Final deliverables (receive-only) 07_to_do/ ← Tasks for externals (read-only)

Note: Templates are included in 00_resources/templates for each content type. Copy them for new tasks and follow naming conventions.


πŸ›  Usage

  1. Run the Project Generator script to create a new project.
  2. Choose root folder, project name, and optional folders (review, to-do).
  3. Templates will be ready in 00_resources/templates.
  4. Use the manual in READ_THE_MANUAL_HERE.md to guide your workflow.
  5. For multi-device work:
    • Main PC: full access, file versioning enabled
    • Externals: limited access (read-only for resources, to-do, review, final; edit only assigned content folders)

πŸ’‘ Nomenclature Guidelines

  • Lowercase letters only
  • Underscores _ instead of spaces
  • Prefix numbers for ordering (001, 002, …)
  • Include content type and date: e.g.,
    001_how_to_saving-video-2025-03-25
  • Maintain consistent folder structure and naming for clarity

πŸ”„ Syncthing Integration

  • Add root folder to Syncthing on all devices.
  • Assign folders with appropriate permissions:
    • Resources, To-Do, Review, Final β†’ receive-only for externals
    • Assigned content folders β†’ send & receive
  • Enable file versioning on main PC (staggered, 365 days)

🌟 Workflow Examples

  • Main PC creates new task folder from template
  • Externals copy assigned template, work, and deliver to review/final
  • Always follow naming conventions
  • Do not delete folders; only edit where allowed
  • Keep a clean, minimal, and intuitive structure (KISS philosophy)

πŸ“Œ Why Use This Generator?

  • Saves setup time for new projects
  • Maintains organization and version control
  • Reduces risk of accidental deletion
  • Provides ready-to-use templates and workflow guidance
  • Ideal for solo creators or small teams/collaborators

✨ Keep it simple, stay organized, and enjoy your creative workflow!
#VERyGoodforlife

About

A simple script to make folders pre-numbered and organized from the start, designed for use with Synchthing and Open Media Vault.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages