Skip to main content

F2. Organize your project

What this page helps you do

Keep your project understandable enough that deploys and fixes do not turn into archaeology.

Why it matters

Messy projects become risky projects. You do not need perfect architecture, but you do need basic clarity.

You should already have

  • a GitHub repo

Skip this page if

  • the repo structure is already obvious and documented

What to do

  • keep app code, config, and docs in predictable places
  • add one short setup section to the README
  • include an example environment file if the app needs secrets or URLs
  • keep deploy-related files easy to find

Prefer boring structure over clever structure.

Common mistakes

  • hidden setup steps that only live in chat history
  • critical deploy settings scattered across random files
  • renaming folders so often that no guide stays current

Next step

Go to F3. Environment settings.

Advanced notes

TODO for contributors: add a simple “good enough” repo layout example for full-stack apps and monorepos.