Project-Delivery

​

Understanding Deliverables

---

​

What you get

Scriptonia produces a project blueprint: structured docs, specs, LLM prompts, and infra notes. It is not a fully runnable app out of the box. You use the prompts and specs to generate or implement code, then deploy using the infra guidance.

---

​

Common artifacts (all platforms)

---

​

By platform

---

​

Website

• docs/ — PRD.md, PLAN.md, SEO_CONTENT.md
• frontend/ — nextjs.md, pages.md, components.md
• frontend/prompts/ — generate_static_site.txt
• content/ — blog/, assets/
• infra/ — hosting.md, cdn_caching.md
• meta/ — github_push.yaml

---

​

Web Application

• docs/ — PRD, PLAN, HUMAN_REVIEW, PROJECT_RULES
• frontend/ — react_nextjs, components, state_management
• frontend/prompts/ — generate_frontend.txt
• backend/ — node_express, services, auth
• backend/apis/ — openapi.md
• db/ — schema, migrations, orm_models
• infra/ — terraform, ci_cd, monitoring, secrets_management
• testing/ — unit_tests, api_tests
• meta/ — github_push.yaml

---

​

Android

• android/ — kotlin_ui, fragments, navigation
• android/prompts/ — generate_android.txt
• backend/ — api_contracts, push_notifications, node_firebase
• db/ — firebase_schema
• infra/ — gcp_deploy
• meta/

---

​

iOS

• ios/ — swiftui, storyboards, navigation, permissions
• ios/prompts/ — generate_ios.txt
• backend/ — api_contracts, push_notifications, node_firebase
• db/ — local_storage (CoreData)
• infra/ — ci_cd
• meta/

---

​

File types

• Markdown (.md) — PRD, PLAN, specs, infra, README, FOLDER_STRUCTURE, REVIEW_REPORT
• YAML (.yaml) — github_push, CI/CD or config
• Prompts (.txt) — LLM prompts used to generate actual code

---

​

Downloading Projects

---

​

When the download is available

On the Execution page, after:

1. Review passed — review_passed === true
2. ZIP generation finished — POST /api/projects/generate completed
3. “Download Project ZIP” is shown and “ZIP file ready!” appears

If Review failed, the download button is not shown.

---

​

How to download

1. Click “Download Project ZIP” on the Execution page
2. App requests GET /api/projects/download?sessionId=...
3. Server returns a ZIP:
   • From ZipFile table, or
   • Built from project directory
4. File is saved as <projectName>.zip or <sessionId>.zip

---

​

What’s in the ZIP

• Same layout as in Understanding Deliverables
• All paths under a single project root
• No extra sessionId folder unless defined by the template

---

​

Completion page

The Completion page (/completion?sessionId=...) shows a summary and next steps.

• Main delivery (download, GitHub) happens on Execution
• Completion is a follow-up view
• You can start a new project from there

---

​

If download fails

• “Project not found” / “Please generate files first” — Execution did not finish or Review failed
• “Failed to download ZIP file” — Network or server error; retry or contact support with sessionId

---

​

GitHub Integration

---

​

Connect GitHub

1. On the Execution page, click “Connect to GitHub”
2. Redirect to /api/github/authorize?sessionId=...
3. GitHub OAuth (scope: repo)
4. Redirect to /api/github/callback, which:
   • Exchanges code for token
   • Sets cookies
   • Redirects back to Execution
5. Execution page shows Connected as <username> and Upload to GitHub

---

​

Upload to GitHub

1. Click “Upload to GitHub”
2. Set:
   • Repository name
   • Description (optional)
   • Private / public
3. Confirm → POST /api/github/upload
4. Server:
   • Creates repo
   • Reads project files
   • Commits and pushes
5. Repo opens in a new tab

---

​

Requirements

• GitHub OAuth configured
• Project files exist after generate
• github_access_token cookie present

---

​

If upload fails

• GitHub not connected — Complete OAuth
• Project files not found — Generate did not complete
• Failed to create repository — Name conflict or missing scope

---

​

Using Generated Code

---

​

Blueprint, not a full app

The ZIP contains specifications, prompts, and infra, not runnable code.

---

​

Suggested order

1. README.md
2. docs/PRD.md, docs/PLAN.md
3. Specs (frontend, backend, db)
4. Prompts
5. infra/

---

​

Prompts

• Located in frontend/prompts/, ios/prompts/, android/prompts/
• Each .txt is an LLM prompt
• Use with matching specs and PRD/PLAN
• Adjust as needed

---

​

Environment and secrets

• Use .env.example as a template
• Fill real values in .env or deployment config
• Do not commit secrets

---

​

Deploy

• Follow infra/ docs
• Use meta/github_push.yaml for CI/CD
• Website: Vercel/Netlify
• Web apps: Docker, AWS, Vercel
• Mobile: App Store Connect, Play Console, Xcode Cloud, GCP

---

​

Next Steps After Delivery

1. Review
2. Customize
3. Generate runnable code
4. Configure
5. Deploy
6. Iterate
7. New project