Download Val Town Project

\n Download any public or unlisted Val Town project as a zip via its URL.\n setURL(e.target.value)}\n placeholder=\"https://www.val.town/x/shouser/getProjectsAsZips\"\n style={{\n display: \"block\",\n \"border\": \"1px solid black\",\n \"padding\": \"10px\",\n \"margin\": \"10px 0\",\n }}\n />\n \n Download\n \n

\n All Projects\n

\n {projects.map((project) => (\n \n \n {project.author.username}/{project.name}\n \n Download\n

\n ))}\n

\n \n );\n}",[],[179,185,191],[179,185],{"_106":201,"_99":202,"_152":203,"_154":180,"_155":138,"_156":157,"_158":120,"_108":204,"_103":33,"_160":205,"_162":206,"_163":27,"_164":-5,"_165":207,"_102":208},"6dd3fda0-f453-11ef-bc06-569c3dd06744","favicon.svg","03da2e10-d7c6-4042-b031-d8261d2abf85",["D",1740582463346],"file","",[],[179,202],{"_106":210,"_99":211,"_152":212,"_154":180,"_155":138,"_156":213,"_158":120,"_108":214,"_103":94,"_160":205,"_162":215,"_163":27,"_164":-5,"_165":216,"_102":217},"c3122abc-f85e-11ef-8043-569c3dd06744","index.html","498baa55-4148-43d3-9d01-fae67f281a18",10,["D",1741027135503],"\n\n \n \n \n Get Projects As Zips\n \n \n \n \n

\n \n \n \n",[],[179,211],{"_106":219,"_99":220,"_152":221,"_154":180,"_155":138,"_156":193,"_158":120,"_108":222,"_103":94,"_160":195,"_162":223,"_163":27,"_164":-5,"_165":224,"_102":225},"50365c68-f55a-11ef-a70e-569c3dd06744","index.tsx","6bb1d7a7-4337-4c95-bc2f-739854a2d610",["D",1740695371325],"/** @jsxImportSource https://esm.sh/react@18.2.0 */\nimport { createRoot } from \"https://esm.sh/react-dom@18.2.0/client\";\nimport { App } from \"./components/App.tsx\";\n\nconst root = document.getElementById(\"root\");\nif (!root) {\n throw new Error(\"No root element found\");\n}\n\ncreateRoot(root).render();",[],[179,220],{"_106":227,"_99":228,"_152":229,"_154":180,"_155":138,"_156":193,"_158":120,"_108":230,"_103":157,"_160":205,"_162":231,"_163":27,"_164":-5,"_165":232,"_102":233},"50365e98-f55a-11ef-a70e-569c3dd06744","style.css","015e39d0-4582-4373-9352-f9568d9ee963",["D",1740695371325],"body {\n font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen, Ubuntu, Cantarell, 'Open Sans', 'Helvetica Neue', sans-serif;\n max-width: 600px;\n margin: 0 auto;\n padding: 20px;\n background-color: #f4f4f4;\n}\n\n.message-board {\n background: white;\n border-radius: 8px;\n box-shadow: 0 4px 6px rgba(0,0,0,0.1);\n padding: 20px;\n}\n\n\n\nfooter {\n text-align: center;\n margin-top: 20px;\n}",[],[179,228],[179],{"_106":236,"_99":237,"_152":238,"_154":-5,"_155":138,"_156":239,"_158":120,"_108":240,"_103":157,"_160":205,"_162":241,"_163":27,"_164":-5,"_165":242,"_102":243},"3bc570a4-f48b-11ef-a48f-569c3dd06744","README.md","a0e2921d-74a9-4e34-a79b-988425cc7fb4",6,["D",1740606431207],"# Download Projects as a Zip\n\nThis is a proof of concept, showing how to download Val Town projects as zip files. For now, I've hardcoded my username into the code, so you can only download my public/unlisted projects. To see it working, type the name of this project **getProjectsAsZips** and press download. Waalaah!\n\nIf you fork this project, you can update the hardcoded username in frontend/MessageInput.tsx. I forked the [reactHonoStarter](https://www.val.town/x/stevekrouse/reactHonoStarter) to get started quickly (it's great), hence the weird naming and leftover code you'll see around this project.\n\n## Next Steps\nI'd love it if someone wanted to send me a PR and tackle either of these two:\n\n1. Add ability for users to input their own username\n2. Add ability for users to input their API token so they can see private projects",[],[237],"files",[149,167,177,183,189,200,209,218,226,235],"counts",{"_248":157,"_249":171,"_250":157,"_251":33},"pulls","branches","forks","envVars","contents",[254,257,260],{"_106":150,"_99":151,"_152":153,"_154":-5,"_155":138,"_156":157,"_158":120,"_108":255,"_103":33,"_160":161,"_162":-5,"_163":27,"_164":-5,"_102":256},["D",1740582463346],[151],{"_106":178,"_99":179,"_152":180,"_154":-5,"_155":138,"_156":157,"_158":120,"_108":258,"_103":33,"_160":161,"_162":-5,"_163":27,"_164":-5,"_102":259},["D",1740582463346],[179],{"_106":236,"_99":237,"_152":238,"_154":-5,"_155":138,"_156":239,"_158":120,"_108":261,"_103":157,"_160":205,"_162":241,"_163":27,"_164":-5,"_102":262},["D",1740606431207],[237],"upstream",{"_106":265,"_99":266,"_114":267,"_115":-5,"_112":113,"_21":268},"41ef0130-f2f5-11ef-891c-569c3dd06744","reactHonoExample","Example with client-side React & Hono server",{"_97":269,"_133":270},"stevekrouse","https://images.clerk.dev/uploaded/img_2PqHa2Gsy93xQrjh2w78Xu0cChW.jpeg","screenshots","emptyEnvVars","routes/_app.x.$handle.$name.branch.$branch.history",{"_97":98,"_99":100,"_101":43,"_104":275,"_279":280,"_462":33,"_463":120},{"_106":107,"_99":100,"_108":276,"_110":-5,"_111":27,"_112":113,"_114":-5,"_115":-5,"_12":116,"_117":118,"_119":120,"_121":-5,"_122":33,"_123":124,"_125":124,"_126":127,"_128":127,"_129":127,"_130":124,"_131":27,"_21":277,"_135":278},["D",1740582463346],{"_97":98,"_133":134},{"_103":137,"_99":43,"_106":138,"_139":107,"_140":141,"_142":143,"_144":113,"_145":146},"history",[281,286,291,300,348,356,425,431,438,444,451],{"_152":118,"_103":137,"_108":282,"_155":138,"_244":283},["D",1741204231628],[284],{"_106":168,"_155":138,"_152":118,"_99":169,"_162":173,"_160":172,"_103":171,"_154":153,"_108":282,"_156":137,"_164":-5,"_158":120,"_163":27,"_102":285},[151,169],{"_152":212,"_103":213,"_108":287,"_155":138,"_244":288},["D",1741027135503],[289],{"_106":210,"_155":138,"_152":212,"_99":211,"_162":215,"_160":205,"_103":94,"_154":180,"_108":287,"_156":213,"_164":-5,"_158":120,"_163":27,"_102":290},[179,211],{"_152":118,"_103":292,"_108":293,"_155":138,"_244":294},9,["D",1740768557847],[295],{"_106":296,"_155":138,"_152":118,"_99":169,"_162":297,"_160":172,"_103":298,"_154":153,"_108":293,"_156":292,"_164":-5,"_158":27,"_163":27,"_102":299},"b6c73466-f604-11ef-8f43-569c3dd06744","import { parseProject, readFile, serveFile } from \"https://esm.town/v/std/utils@71-main/index.ts\";\nimport ValTown from \"npm:@valtown/sdk\";\nimport { Hono } from \"npm:hono\";\nimport JSZip from \"npm:jszip\";\n\nconst app = new Hono();\nconst vt = new ValTown();\n\n// Bootstrap the initial messages data into index.html\nconst projects = await getAllProjects();\n\n// Serve index.html at the root /\napp.get(\"/\", async c => {\n let html = await readFile(\"/frontend/index.html\", import.meta.url);\n\n // Inject the data as a global variable inside a script tag\n const dataScript = ``;\n\n // Insert the script right before the closing tag\n html = html.replace(\"\", `${dataScript}`);\n\n return c.html(html);\n});\n\nasync function getAllProjects() {\n let offset = 0;\n const limit = 100;\n let allProjects = [];\n let hasMore = true;\n\n while (hasMore && allProjects.length < 1000) {\n const projects = await vt.projects.list({ limit, offset });\n\n allProjects = [...allProjects, ...projects.data];\n offset = allProjects.length;\n hasMore = projects.data.length === limit;\n }\n\n return allProjects;\n}\n\n// Serve all /frontend files under /public\napp.get(\"/public/**/*\", c => serveFile(c.req.path.replace(\"/public\", \"/frontend\"), import.meta.url));\n\n// Serve all /shared files under /shared\napp.get(\"/shared/**/*\", c => serveFile(c.req.path, import.meta.url));\n\napp.get(\"/zip-project\", async (c) => {\n const url = c.req.query(\"url\");\n\n if (!url) {\n return c.json({\n success: false,\n error: \"Missing required parameter: url\",\n }, 400);\n }\n\n const { username, projectName } = parseValTownProjectURL(url);\n\n if (!username || !projectName) {\n return c.json({\n success: false,\n error: \"Missing required parameters: username and projectName\",\n }, 400);\n }\n\n const projectDetails = await vt.alias.username.projectName.retrieve(username, projectName);\n\n if (!projectDetails || !projectDetails.id) {\n return c.json({\n success: false,\n error: \"Project not found\",\n }, 404);\n }\n\n const projectId = projectDetails.id;\n const files = await vt.projects.files.list(projectId, { recursive: true });\n const filesWithContent = await getFilesWithContent(files.body.data, projectId);\n const zipBuffer = await createZipFromEndpoints(filesWithContent, `${projectName}.zip`);\n\n c.header(\"Content-Type\", \"application/zip\");\n c.header(\"Content-Disposition\", `attachment; filename=\"${projectName}.zip\"`);\n\n // Return the ZIP file directly\n return c.body(zipBuffer, 200);\n});\n\nfunction parseValTownProjectURL(url: string) {\n // Use the URL constructor to parse the URL\n const { pathname } = new URL(url);\n // Split the pathname and filter out empty segments\n const parts = pathname.split(\"/\").filter(Boolean);\n // Expecting the format: [\"x\", \"stevekrouse\", \"getProjectsAsZips\"]\n if (parts.length < 3 || parts[0] !== \"x\") {\n throw new Error(\"Invalid URL structure\");\n }\n const username = parts[1];\n const projectName = parts[2];\n return { username, projectName };\n}\nasync function getFilesWithContent(files: any[], projectId) {\n const nonDirectoryFiles = files.filter(file => file.type !== \"directory\");\n\n const failedFiles = [];\n\n const filePromises = nonDirectoryFiles.map(async file => {\n try {\n const urlEncodedPath = encodeURIComponent(file.path);\n console.log(\"url encoded path\", urlEncodedPath);\n const response = await vt.projects.files.content(projectId, urlEncodedPath);\n\n if (!response) {\n throw new Error(`Could not get content for file: ${file.path}`);\n }\n\n return {\n name: file.path,\n content: response,\n };\n } catch (error) {\n failedFiles.push({\n path: file.path,\n error: error.message,\n });\n }\n });\n\n const results = await Promise.all(filePromises);\n if (failedFiles.length > 0) {\n const failedFilesList = failedFiles.map(f => `'${f.path}': ${f.error}`).join(\", \");\n throw new Error(`Failed to fetch content for files: ${failedFilesList}`);\n }\n\n return results;\n}\n\nasync function createZipFromEndpoints(\n files: any[],\n zipFileName: string,\n): Promise {\n try {\n const zip = new JSZip();\n\n for (const file of files) {\n zip.file(file.name, file.content);\n }\n\n const zipBlob = await zip.generateAsync({\n type: \"blob\",\n compression: \"DEFLATE\",\n compressionOptions: { level: 6 },\n });\n\n return zipBlob;\n } catch (error) {\n console.error(\"Error creating ZIP file:\", error);\n throw error;\n }\n}\n\n// Unwrap and rethrow Hono errors as the original error\n// If you delete this, all errors will be \"Internal Server Error\"\napp.onError((err, c) => {\n throw err;\n});\n\n// HTTP vals expect an exported \"fetch handler\"\n// This is how you \"run the server\" in Val Town with Hono\nexport default app.fetch;",4,[151,169],{"_152":301,"_103":193,"_108":302,"_155":138,"_244":303},"7a720519-1bc3-4623-b21e-ee5f7fa145ff",["D",1740695371325],[304,308,315,322,329,332,337,340,345],{"_106":305,"_155":138,"_152":301,"_99":306,"_162":-5,"_160":161,"_103":157,"_154":-5,"_108":302,"_156":193,"_164":-5,"_158":120,"_163":120,"_102":307},"50362d42-f55a-11ef-a70e-569c3dd06744","shared",[306],{"_106":309,"_155":138,"_152":310,"_99":311,"_162":312,"_160":195,"_103":94,"_154":301,"_108":313,"_156":193,"_164":-5,"_158":120,"_163":120,"_102":314},"5036301c-f55a-11ef-a70e-569c3dd06744","4df91d83-79a6-4622-939e-2addea28d63c","utils.ts","// LEFTOVER FROM TEMPLATE, NOT USED\nexport interface Message {\n content: string;\n}\n\nexport const MESSAGE_LIMIT = 5;",["D",1740695371325],[306,311],{"_106":316,"_155":138,"_152":317,"_99":237,"_162":318,"_160":205,"_103":319,"_154":153,"_108":320,"_156":193,"_164":-5,"_158":120,"_163":120,"_102":321},"50362626-f55a-11ef-a70e-569c3dd06744","bab2a0af-7cf8-4204-b0e4-7618df3d1715","# Backend\n\nThis folder contains all backend-only code in this project. It's broken up into:\n\n* `index.ts` - this is the **entrypoint** for this whole project\n\n## Hono\n\nThis app uses [Hono](https://hono.dev/) as the API framework. You can think of Hono as a replacement for [ExpressJS](https://expressjs.com/) that works in serverless environments like Val Town or Cloudflare Workers. If you come from Python or Ruby, Hono is also a lot like [Flask](https://github.com/pallets/flask) or [Sinatra](https://github.com/sinatra/sinatra), respectively.\n\n## Serving assets to the frontend\n\nThis backend HTTP server is responsible for serving all static assets to the browser to render the app, including HTML, JavaScript (including all client-side React), CSS, and even the favicon SVG.\n\nIn a normal server environment, you would likely use a middleware [like this one](https://hono.dev/docs/getting-started/nodejs#serve-static-files) to serve static files. Some frameworks or deployment platforms automatically make any content inside a `public/` folder public. \n\nHowever in Val Town you need to handle this yourself, and it can be suprisingly difficult to read and serve files in a Val Town Project. This template uses helper functions from [stevekrouse/utils/serve-public](https://www.val.town/x/stevekrouse/utils/branch/main/code/serve-public/README.md), which handle reading project files in a way that will work across branches and forks, automatically transpiles typescript to javascript, and assigns content-types based on the file's extension.\n\n### `index.html`\n\nThe most complicated part of this backend API is serving index.html. In this app (like most apps) we serve it at the root, ie `GET /`. \n\nWe *bootstrap* `index.html` with some initial data from the server, so that it gets dynamically injected JSON data without having to make another round-trip request to the server to get that data on the frontend. This is a common pattern for client-side rendered apps.\n\n## CRUD API Routes\n\nThis app has two CRUD API routes: for reading and inserting into the messages table. They both speak JSON, which is standard. They import their functions from `/backend/database/queries.ts`. These routes are called from the React app to refresh and update data.\n\n## Errors\n\nHono and other API frameworks have a habit of swallowing up Errors. We turn off this default behavior by re-throwing errors, because we think most of the time you'll want to see the full stack trace instead of merely \"Internal Server Error\". You can customize how you want errors to appear.",3,["D",1740695371325],[151,237],{"_106":323,"_155":138,"_152":324,"_99":325,"_162":326,"_160":195,"_103":94,"_154":186,"_108":327,"_156":193,"_164":-5,"_158":120,"_163":120,"_102":328},"50362b80-f55a-11ef-a70e-569c3dd06744","01d0cd08-fdb0-46f8-8efa-b87bb7404a74","MessageInput.tsx","/** @jsxImportSource https://esm.sh/react@18.2.0 */\nimport React from \"https://esm.sh/react@18.2.0\";\nimport type { Message } from \"../shared/types.ts\";\n\nexport function MessageInput({ onSubmit }: { onSubmit: () => void }) {\n const [message, setMessage] = React.useState(\"\");\n\n const handleSubmit = async (e: React.FormEvent) => {\n e.preventDefault();\n if (!message.trim()) return;\n\n try {\n const username = \"shouser\"; // PUT YOUR USERNAME HERE\n const projectName = message.trim();\n const response = await fetch(\n `/zip-project?username=${encodeURIComponent(username)}&projectName=${encodeURIComponent(projectName)}`,\n {\n method: \"POST\",\n headers: { \"Content-Type\": \"application/json\" },\n },\n );\n\n if (response.ok) {\n const blob = await response.blob();\n const url = URL.createObjectURL(blob);\n\n const downloadLink = document.createElement(\"a\");\n downloadLink.href = url;\n downloadLink.download = `${projectName}.zip`;\n document.body.appendChild(downloadLink);\n downloadLink.click();\n document.body.removeChild(downloadLink);\n\n setTimeout(() => {\n URL.revokeObjectURL(url);\n }, 100);\n\n onSubmit();\n setMessage(\"\");\n }\n } catch (error) {\n console.error(\"Download failed\", error);\n }\n };\n\n return (\n

\n setMessage(e.target.value)}\n placeholder=\"Type a project name...\"\n />\n \n \n );\n}",["D",1740695371325],[179,185,325],{"_106":219,"_155":138,"_152":221,"_99":220,"_162":223,"_160":195,"_103":94,"_154":180,"_108":330,"_156":193,"_164":-5,"_158":120,"_163":27,"_102":331},["D",1740695371325],[179,220],{"_106":333,"_155":138,"_152":212,"_99":211,"_162":334,"_160":205,"_103":157,"_154":180,"_108":335,"_156":193,"_164":-5,"_158":27,"_163":27,"_102":336},"50365916-f55a-11ef-a70e-569c3dd06744","\n\n \n \n \n Get Projects As Zips\n \n \n \n \n

\n \n \n",["D",1740695371325],[179,211],{"_106":190,"_155":138,"_152":192,"_99":191,"_162":196,"_160":195,"_103":94,"_154":186,"_108":338,"_156":193,"_164":-5,"_158":120,"_163":27,"_102":339},["D",1740695371325],[179,185,191],{"_106":341,"_155":138,"_152":118,"_99":169,"_162":342,"_160":172,"_103":319,"_154":153,"_108":343,"_156":193,"_164":-5,"_158":27,"_163":27,"_102":344},"50363896-f55a-11ef-a70e-569c3dd06744","import { parseProject, readFile, serveFile } from \"https://esm.town/v/std/utils@71-main/index.ts\";\nimport ValTown from \"npm:@valtown/sdk\";\nimport { Hono } from \"npm:hono\";\nimport JSZip from \"npm:jszip\";\n\nconst app = new Hono();\nconst vt = new ValTown();\n\n// Bootstrap the initial messages data into index.html\nconst projects = await getAllProjects();\n\n// Serve index.html at the root /\napp.get(\"/\", async c => {\n let html = await readFile(\"/frontend/index.html\", import.meta.url);\n\n // Inject the data as a global variable inside a script tag\n const dataScript = ``;\n\n // Insert the script right before the closing tag\n html = html.replace(\"\", `${dataScript}`);\n\n return c.html(html);\n});\n\nasync function getAllProjects() {\n let projects = await vt.projects.list({ limit: 100, offset: 0 });\n let allProjects = [...projects.data];\n while (projects.data.length === 100 && allProjects.length < 1000) {\n projects = await vt.projects.list({ limit: 100, offset: projects.data.length });\n allProjects = [...allProjects, ...projects.data];\n }\n return allProjects;\n}\n\n// Serve all /frontend files under /public\napp.get(\"/public/**/*\", c => serveFile(c.req.path.replace(\"/public\", \"/frontend\"), import.meta.url));\n\n// Serve all /shared files under /shared\napp.get(\"/shared/**/*\", c => serveFile(c.req.path, import.meta.url));\n\napp.get(\"/zip-project\", async (c) => {\n const url = c.req.query(\"url\");\n\n if (!url) {\n return c.json({\n success: false,\n error: \"Missing required parameter: url\",\n }, 400);\n }\n\n const { username, projectName } = parseValTownProjectURL(url);\n\n if (!username || !projectName) {\n return c.json({\n success: false,\n error: \"Missing required parameters: username and projectName\",\n }, 400);\n }\n\n const projectDetails = await vt.alias.username.projectName.retrieve(username, projectName);\n\n if (!projectDetails || !projectDetails.id) {\n return c.json({\n success: false,\n error: \"Project not found\",\n }, 404);\n }\n\n const projectId = projectDetails.id;\n const files = await vt.projects.files.list(projectId, { recursive: true });\n const filesWithContent = await getFilesWithContent(files.body.data, projectId);\n const zipBuffer = await createZipFromEndpoints(filesWithContent, `${projectName}.zip`);\n\n c.header(\"Content-Type\", \"application/zip\");\n c.header(\"Content-Disposition\", `attachment; filename=\"${projectName}.zip\"`);\n\n // Return the ZIP file directly\n return c.body(zipBuffer, 200);\n});\n\nfunction parseValTownProjectURL(url: string) {\n // Use the URL constructor to parse the URL\n const { pathname } = new URL(url);\n // Split the pathname and filter out empty segments\n const parts = pathname.split(\"/\").filter(Boolean);\n // Expecting the format: [\"x\", \"stevekrouse\", \"getProjectsAsZips\"]\n if (parts.length < 3 || parts[0] !== \"x\") {\n throw new Error(\"Invalid URL structure\");\n }\n const username = parts[1];\n const projectName = parts[2];\n return { username, projectName };\n}\nasync function getFilesWithContent(files: any[], projectId) {\n const nonDirectoryFiles = files.filter(file => file.type !== \"directory\");\n\n const failedFiles = [];\n\n const filePromises = nonDirectoryFiles.map(async file => {\n try {\n const urlEncodedPath = encodeURIComponent(file.path);\n console.log(\"url encoded path\", urlEncodedPath);\n const response = await vt.projects.files.content(projectId, urlEncodedPath);\n\n if (!response) {\n throw new Error(`Could not get content for file: ${file.path}`);\n }\n\n return {\n name: file.path,\n content: response,\n };\n } catch (error) {\n failedFiles.push({\n path: file.path,\n error: error.message,\n });\n }\n });\n\n const results = await Promise.all(filePromises);\n if (failedFiles.length > 0) {\n const failedFilesList = failedFiles.map(f => `'${f.path}': ${f.error}`).join(\", \");\n throw new Error(`Failed to fetch content for files: ${failedFilesList}`);\n }\n\n return results;\n}\n\nasync function createZipFromEndpoints(\n files: any[],\n zipFileName: string,\n): Promise {\n try {\n const zip = new JSZip();\n\n for (const file of files) {\n zip.file(file.name, file.content);\n }\n\n const zipBlob = await zip.generateAsync({\n type: \"blob\",\n compression: \"DEFLATE\",\n compressionOptions: { level: 6 },\n });\n\n return zipBlob;\n } catch (error) {\n console.error(\"Error creating ZIP file:\", error);\n throw error;\n }\n}\n\n// Unwrap and rethrow Hono errors as the original error\n// If you delete this, all errors will be \"Internal Server Error\"\napp.onError((err, c) => {\n throw err;\n});\n\n// HTTP vals expect an exported \"fetch handler\"\n// This is how you \"run the server\" in Val Town with Hono\nexport default app.fetch;",["D",1740695371325],[151,169],{"_106":227,"_155":138,"_152":229,"_99":228,"_162":231,"_160":205,"_103":157,"_154":180,"_108":346,"_156":193,"_164":-5,"_158":120,"_163":27,"_102":347},["D",1740695371325],[179,228],{"_152":118,"_103":349,"_108":350,"_155":138,"_244":351},7,["D",1740667190853],[352],{"_106":353,"_155":138,"_152":118,"_99":169,"_162":354,"_160":172,"_103":94,"_154":153,"_108":350,"_156":349,"_164":-5,"_158":27,"_163":27,"_102":355},"b357fb4a-f518-11ef-83fc-569c3dd06744","import { parseProject } from \"https://esm.town/v/std/parseImportMeta@149-main/project\";\nimport { readFile, servePublicFile } from \"https://esm.town/v/stevekrouse/utils@187-main/serve-public/index.ts\";\nimport ValTown from \"npm:@valtown/sdk\";\nimport { Hono } from \"npm:hono\";\nimport JSZip from \"npm:jszip\";\n\nconst app = new Hono();\nconst vt = new ValTown();\n\n// Serve index.html at the root /\napp.get(\"/\", async c => {\n let html = await readFile(\"/frontend/index.html\", import.meta.url);\n\n return c.html(html);\n});\n\n// Serve all /frontend files under /public\napp.get(\"/public/**/*\", c => servePublicFile(c.req.path.replace(\"/public\", \"/frontend\"), import.meta.url));\n\n// Serve all /shared files under /shared\napp.get(\"/shared/**/*\", c => servePublicFile(c.req.path, import.meta.url));\n\napp.post(\"/zip-project\", async (c) => {\n try {\n const username = c.req.query(\"username\");\n const projectName = c.req.query(\"projectName\");\n\n if (!username || !projectName) {\n return c.json({\n success: false,\n error: \"Missing required parameters: username and projectName\",\n }, 400);\n }\n\n const projectDetails = await vt.alias.username.projectName.retrieve(username, projectName);\n\n if (!projectDetails || !projectDetails.id) {\n return c.json({\n success: false,\n error: \"Project not found\",\n }, 404);\n }\n\n const projectId = projectDetails.id;\n const files = await vt.projects.files.list(projectId, { recursive: true });\n const filesWithContent = await getFilesWithContent(files.body.data, projectId);\n const zipBuffer = await createZipFromEndpoints(filesWithContent, `${projectName}.zip`);\n\n c.header(\"Content-Type\", \"application/zip\");\n c.header(\"Content-Disposition\", `attachment; filename=\"${projectName}.zip\"`);\n\n // Return the ZIP file directly\n return c.body(zipBuffer, 200);\n } catch (error) {\n console.error(\"Error retrieving project files:\", error);\n return c.json({\n success: false,\n error: error,\n }, 500);\n }\n});\n\nasync function getFilesWithContent(files: any[], projectId) {\n const nonDirectoryFiles = files.filter(file => file.type !== \"directory\");\n\n const failedFiles = [];\n\n const filePromises = nonDirectoryFiles.map(async file => {\n try {\n const urlEncodedPath = encodeURIComponent(file.path);\n console.log(\"url encoded path\", urlEncodedPath);\n const response = await vt.projects.files.content(projectId, urlEncodedPath);\n\n if (!response) {\n throw new Error(`Could not get content for file: ${file.path}`);\n }\n\n return {\n name: file.path,\n content: response,\n };\n } catch (error) {\n failedFiles.push({\n path: file.path,\n error: error.message,\n });\n }\n });\n\n const results = await Promise.all(filePromises);\n if (failedFiles.length > 0) {\n const failedFilesList = failedFiles.map(f => `'${f.path}': ${f.error}`).join(\", \");\n throw new Error(`Failed to fetch content for files: ${failedFilesList}`);\n }\n\n return results;\n}\n\nasync function createZipFromEndpoints(\n files: any[],\n zipFileName: string,\n): Promise {\n try {\n const zip = new JSZip();\n\n for (const file of files) {\n zip.file(file.name, file.content);\n }\n\n const zipBlob = await zip.generateAsync({\n type: \"blob\",\n compression: \"DEFLATE\",\n compressionOptions: { level: 6 },\n });\n\n return zipBlob;\n } catch (error) {\n console.error(\"Error creating ZIP file:\", error);\n throw error;\n }\n}\n\n// Unwrap and rethrow Hono errors as the original error\n// If you delete this, all errors will be \"Internal Server Error\"\napp.onError((err, c) => {\n throw err;\n});\n\n// HTTP vals expect an exported \"fetch handler\"\n// This is how you \"run the server\" in Val Town with Hono\nexport default app.fetch;",[151,169],{"_152":357,"_103":239,"_108":358,"_155":138,"_244":359},"2932c059-ff75-4a32-8798-e07ca51ef9c4",["D",1740606431207],[360,364,369,375,379,384,388,395,402,405,409,415,421],{"_106":361,"_155":138,"_152":357,"_99":237,"_162":362,"_160":205,"_103":157,"_154":301,"_108":358,"_156":239,"_164":-5,"_158":120,"_163":120,"_102":363},"3bc56f0a-f48b-11ef-a48f-569c3dd06744","# Shared\n\nIt's common to have code and types that are needed on both the frontend and the backend. It's important that you write this code in a particularly defensive way because it's limited by what both environments support:\n\n![shapes at 25-02-25 11.57.13.png](https://imagedelivery.net/iHX6Ovru0O7AjmyT5yZRoA/75db1d51-d9b3-45e0-d178-25d886c10700/public)\n\nFor example, you *cannot* use the `Deno` keyword. For imports, you can't use `npm:` specifiers, so we reccomend `https://esm.sh` because it works on the server & client. You *can* use TypeScript because that is transpiled in `/backend/index.ts` for the frontend. Most code that works on the frontend tends to work in Deno, because Deno is designed to support \"web-standards\", but there are definitely edge cases to look out for.",[306,237],{"_106":365,"_155":138,"_152":192,"_99":191,"_162":366,"_160":195,"_103":157,"_154":186,"_108":367,"_156":239,"_164":-5,"_158":27,"_163":27,"_102":368},"3bc57c2a-f48b-11ef-a48f-569c3dd06744","/** @jsxImportSource https://esm.sh/react@18.2.0 */\nimport React from \"https://esm.sh/react@18.2.0\";\nimport { type Message, MESSAGE_LIMIT } from \"../../shared/utils.ts\";\nimport { MessageInput } from \"./MessageInput.tsx\";\n\nexport function App(\n { initialMessages = [], thisProjectURL }: { initialMessages?: Message[]; thisProjectURL?: string },\n) {\n const [messages, setMessages] = React.useState(initialMessages);\n\n return (\n

Get Sophie's Project

\n \n {thisProjectURL\n ? (\n \n )\n : null}\n

\n );\n}",["D",1740606431207],[179,185,191],{"_106":370,"_155":138,"_152":371,"_99":372,"_162":-5,"_160":161,"_103":157,"_154":153,"_108":373,"_156":239,"_164":-5,"_158":120,"_163":120,"_102":374},"3bc56640-f48b-11ef-a48f-569c3dd06744","487934d6-a110-4cde-8770-136729fc540a","database",["D",1740606431207],[151,372],{"_106":376,"_155":138,"_152":118,"_99":169,"_162":354,"_160":172,"_103":157,"_154":153,"_108":377,"_156":239,"_164":-5,"_158":27,"_163":27,"_102":378},"3bc575ea-f48b-11ef-a48f-569c3dd06744",["D",1740606431207],[151,169],{"_106":380,"_155":138,"_152":221,"_99":220,"_162":381,"_160":195,"_103":157,"_154":180,"_108":382,"_156":239,"_164":-5,"_158":27,"_163":27,"_102":383},"3bc58008-f48b-11ef-a48f-569c3dd06744","/** @jsxImportSource https://esm.sh/react@18.2.0 */\nimport { createRoot } from \"https://esm.sh/react-dom@18.2.0/client\";\nimport { App } from \"./components/App.tsx\";\n\nconst root = document.getElementById(\"root\");\nif (!root) {\n throw new Error(\"No root element found\");\n}\n\ndeclare global {\n interface Window {\n __INITIAL_DATA__: {};\n }\n}\n\ncreateRoot(root).render();",["D",1740606431207],[179,220],{"_106":385,"_155":138,"_152":324,"_99":325,"_162":326,"_160":195,"_103":157,"_154":186,"_108":386,"_156":239,"_164":-5,"_158":27,"_163":27,"_102":387},"3bc57e0a-f48b-11ef-a48f-569c3dd06744",["D",1740606431207],[179,185,325],{"_106":389,"_155":138,"_152":390,"_99":391,"_162":392,"_160":195,"_103":157,"_154":371,"_108":393,"_156":239,"_164":-5,"_158":120,"_163":120,"_102":394},"3bc56ad2-f48b-11ef-a48f-569c3dd06744","0174984d-9d1c-4b7f-a0b1-b9fd5697dd09","migrations.ts","import { sqlite } from \"https://esm.town/v/stevekrouse/sqlite\";\n\nexport const tableName = \"reactHonoStarter_messages\";\n\nexport async function createTables() {\n await sqlite.batch([\n `CREATE TABLE IF NOT EXISTS ${tableName} (\n id INTEGER PRIMARY KEY AUTOINCREMENT,\n content TEXT NOT NULL,\n timestamp DATETIME DEFAULT CURRENT_TIMESTAMP\n )`,\n /* Add any other tables or migrations you want here\n\n However, you should know that SQLite has much more limited\n support for altering existing tables as compared to other databases.\n Often it's easier to create new tables with the schema you want, and then\n copy the data over. */\n ]);\n}",["D",1740606431207],[151,372,391],{"_106":396,"_155":138,"_152":397,"_99":398,"_162":399,"_160":195,"_103":94,"_154":371,"_108":400,"_156":239,"_164":-5,"_158":120,"_163":120,"_102":401},"3bc56bea-f48b-11ef-a48f-569c3dd06744","9d4b8fe5-5e67-4e1e-b475-4fb0a91a1c1c","queries.ts","import { sqlite } from \"https://esm.town/v/stevekrouse/sqlite\";\nimport { type Message, MESSAGE_LIMIT } from \"../../shared/utils.ts\";\nimport { createTables, tableName } from \"./migrations.ts\";\n\n// This will create the database table if it doesn't exist.\n// This will run every time the app starts up. You can\n// comment out this line for a modest (30ms) performance improvement\n// on cold starts. It's left in to ensure the database tables are\n// automatically set up correctly for users who fork this app.\nawait createTables();\n\nexport async function getMessages(limit = MESSAGE_LIMIT): Promise {\n const messages = await sqlite.execute(\n `SELECT * FROM ${tableName} \n ORDER BY timestamp DESC \n LIMIT ?`,\n [limit],\n );\n return messages.rows as unknown as Message[];\n}\n\nexport async function insertMessage(content: string) {\n await sqlite.execute(\n `INSERT INTO ${tableName} (content) \n VALUES (?)`,\n [content],\n );\n}",["D",1740606431207],[151,372,398],{"_106":236,"_155":138,"_152":238,"_99":237,"_162":241,"_160":205,"_103":157,"_154":-5,"_108":403,"_156":239,"_164":-5,"_158":120,"_163":27,"_102":404},["D",1740606431207],[237],{"_106":406,"_155":138,"_152":317,"_99":237,"_162":318,"_160":205,"_103":94,"_154":153,"_108":407,"_156":239,"_164":-5,"_158":27,"_163":27,"_102":408},"3bc57310-f48b-11ef-a48f-569c3dd06744",["D",1740606431207],[151,237],{"_106":410,"_155":138,"_152":411,"_99":237,"_162":412,"_160":205,"_103":157,"_154":371,"_108":413,"_156":239,"_164":-5,"_158":120,"_163":120,"_102":414},"3bc5692e-f48b-11ef-a48f-569c3dd06744","beda0a38-82e7-43ae-ade4-30bcd2119b0a","# Database\n\nThis app uses [Val Town SQLite](https://docs.val.town/std/sqlite/) to manage data. Every Val Town account comes with a free SQLite database, hosted on [Turso](https://turso.tech/). This folder is broken up into two files:\n\n* `migrations.ts` - code to set up the database tables the app needs\n* `queries.ts` - functions to run queries against those tables, which are imported and used in the main Hono server in `/backend/index.ts`\n\n## Migrations\n\nIn `backend/database/migrations.ts`, this app creates a new SQLite table `reactHonoStarter_messages` to store messages. \n\nThis \"migration\" runs once on every app startup because it's imported in `index.ts`. You can comment this line out for a slight (30ms) performance improvement on cold starts. It's left in so that users who fork this project will have the migration run correctly.\n\nSQLite has much more limited support for altering existing tables as compared to other databases. Often it's easier to create new tables with the schema you want, and then copy the data over. Happily LLMs are quite good at those sort of database operations, but please reach out in the [Val Town Discord](https://discord.com/invite/dHv45uN5RY) if you need help.\n\n## Queries\n\nThe queries file is where running the migrations happen in this app. It'd also be reasonable for that to happen in index.ts, or as is said above, for that line to be commented out, and only run when actual changes are made to your database schema.\n\nThe queries file exports functions to get and write data. It relies on shared types and data imported from the `/shared` directory.",["D",1740606431207],[151,372,237],{"_106":416,"_155":138,"_152":417,"_99":237,"_162":418,"_160":205,"_103":319,"_154":180,"_108":419,"_156":239,"_164":-5,"_158":120,"_163":120,"_102":420},"3bc56cf8-f48b-11ef-a48f-569c3dd06744","ffff6849-4757-460e-a74f-947cb82d930e","# Frontend\n\nThis template is a classic client-side-only React app. \n\n## `index.html`\n\nThe **entrypoint** for the frontend is `/frontend/index.html`. This is the HTML page that is returned at the root from `/backend/index.ts`.\n\nThis HTML file imports `/frontend/style.css` from `/public/style.css` and `/frontend/favicon.svg` from `/frontend/favicon.svg`. Everything in `/frontend/` is mapped to `/public` by `/backend/index.ts`. This is just a convention. You could import & serve everything out of the same folder name.\n\nThis HTML file has a `

`, which is where we mount the React app.\n\nThis HTML file imports `/frontend/index.tsx` from `/public/index.tsx`, which is the **entrypoint** for all frontend JavaScript, including all the React. It is not a problem that it imports a file with a `.tsx` extension because browsers ignore file extensions. They only pay attention to content-types, which is great, because all these files will be returned as transpiled JS with the appropriate JS content type by [stevekrouse/utils/serve-public](https://www.val.town/x/stevekrouse/utils/branch/main/code/serve-public/README.md).\n\n## `index.tsx`\n\nThis file is the **entrypoint** for frontend JavaScript. It imports the React app from `/frontend/components/App.tsx` and mounts it on `

`, which is where we mount the React app.\n\nThis HTML file imports `/frontend/index.tsx` from `/public/index.tsx`, which is the **entrypoint** for all frontend JavaScript, including all the React. It is not a problem that it imports a file with a `.tsx` extension because browsers ignore file extensions. They only pay attention to content-types, which is great, because all these files will be returned as transpiled JS with the appropriate JS content type by [stevekrouse/utils/serve-public](https://www.val.town/x/stevekrouse/utils/branch/main/code/serve-public/README.md).)\n\n## `index.tsx`\n\nThis file is the **entrypoint** for frontend JavaScript. It imports the React app from `/frontend/components/App.tsx` and mounts it on `

`.\n\nIt also looks for *bootstrapped* JSON data at `window.__INITIAL_DATA`, and passes that only to the ``.\n\n## `favicon.svg`\n\nAs of this writing Val Town only supports text files, which is why the favicon is an SVG and not an .ico or any other binary image format. If you need binary file storage, check out [Blob Storage](https://docs.val.town/std/blob/).\n\n## `components/`\n\nThis directory is where the React components are stored. They're pretty standard client-side React components.",[179,237],{"_152":397,"_103":319,"_108":439,"_155":138,"_244":440},["D",1740582718847],[441],{"_106":442,"_155":138,"_152":397,"_99":398,"_162":399,"_160":195,"_103":157,"_154":371,"_108":439,"_156":319,"_164":-5,"_158":27,"_163":27,"_102":443},"0619df3a-f454-11ef-9067-569c3dd06744",[151,372,398],{"_152":317,"_103":94,"_108":445,"_155":138,"_244":446},["D",1740582561193],[447],{"_106":448,"_155":138,"_152":317,"_99":237,"_162":449,"_160":205,"_103":157,"_154":153,"_108":445,"_156":94,"_164":-5,"_158":27,"_163":27,"_102":450},"a821ebd4-f453-11ef-91b3-569c3dd06744","# Backend\n\nThis folder contains all backend-only code in this project. It's broken up into:\n\n* `index.ts` - this is the **entrypoint** for this whole project\n* `database/` - this contains the code for interfacing with the app's SQLite database table\n\n## Hono\n\nThis app uses [Hono](https://hono.dev/) as the API framework. You can think of Hono as a replacement for [ExpressJS](https://expressjs.com/) that works in serverless environments like Val Town or Cloudflare Workers. If you come from Python or Ruby, Hono is also a lot like [Flask](https://github.com/pallets/flask) or [Sinatra](https://github.com/sinatra/sinatra), respectively.\n\n## Serving assets to the frontend\n\nThis backend HTTP server is responsible for serving all static assets to the browser to render the app, including HTML, JavaScript (including all client-side React), CSS, and even the favicon SVG.\n\nIn a normal server environment, you would likely use a middleware [like this one](https://hono.dev/docs/getting-started/nodejs#serve-static-files) to serve static files. Some frameworks or deployment platforms automatically make any content inside a `public/` folder public. \n\nHowever in Val Town you need to handle this yourself, and it can be suprisingly difficult to read and serve files in a Val Town Project. This template uses helper functions from [stevekrouse/utils/serve-public](https://www.val.town/x/stevekrouse/utils/branch/main/code/serve-public/README.md), which handle reading project files in a way that will work across branches and forks, automatically transpiles typescript to javascript, and assigns content-types based on the file's extension.\n\n### `index.html`\n\nThe most complicated part of this backend API is serving index.html. In this app (like most apps) we serve it at the root, ie `GET /`. \n\nWe *bootstrap* `index.html` with some initial data from the server, so that it gets dynamically injected JSON data without having to make another round-trip request to the server to get that data on the frontend. This is a common pattern for client-side rendered apps.\n\n## CRUD API Routes\n\nThis app has two CRUD API routes: for reading and inserting into the messages table. They both speak JSON, which is standard. They import their functions from `/backend/database/queries.ts`. These routes are called from the React app to refresh and update data.\n\n## Errors\n\nHono and other API frameworks have a habit of swallowing up Errors. We turn off this default behavior by re-throwing errors, because we think most of the time you'll want to see the full stack trace instead of merely \"Internal Server Error\". You can customize how you want errors to appear.",[151,237],{"_152":317,"_103":157,"_108":452,"_155":138,"_244":453},["D",1740582463346],[454,458],{"_106":455,"_155":138,"_152":317,"_99":237,"_162":456,"_160":205,"_103":33,"_154":153,"_108":452,"_156":157,"_164":-5,"_158":27,"_163":27,"_102":457},"6dd3e694-f453-11ef-bc06-569c3dd06744","# Backend\n\nThis folder contains all backend-only code in this project. It's broken up into:\n\n* `index.ts` - this is the **entrypoint** for this whole project\n* `database/` - this contains the code for interfacing with the app's SQLite database table\n\n## Hono\n\nThis app uses [Hono](https://hono.dev/) has the a API framework. You can think of Hono as a replacement for [ExpressJS](https://expressjs.com/) that works in serverless environments like Val Town or Cloudflare Workers. If you come from Python or Ruby, Hono is also a lot like [Flask](https://github.com/pallets/flask) or [Sinatra](https://github.com/sinatra/sinatra), respectively.\n\n## Serving assets to the frontend\n\nThis backend HTTP server is responsible for serving all static assets to the browser to render the app, including HTML, JavaScript (including all client-side React), CSS, and even the favicon SVG.\n\nIn a normal server environment, you would likely use a middleware [like this one](https://hono.dev/docs/getting-started/nodejs#serve-static-files) to serve static files. Some frameworks or deployment platforms automatically make any content inside a `public/` folder public. \n\nHowever in Val Town you need to handle this yourself, and it can be suprisingly difficult to read and serve files in a Val Town Project. This template uses helper functions from [stevekrouse/utils/serve-public](https://www.val.town/x/stevekrouse/utils/branch/main/code/serve-public/README.md), which handle reading project files in a way that will work across branches and forks, automatically transpiles typescript to javascript, and assigns content-types based on the file's extension.\n\n### `index.html`\n\nThe most complicated part of this backend API is serving index.html. In this app (like most apps) we serve it at the root, ie `GET /`. \n\nWe *bootstrap* `index.html` with some initial data from the server, so that it gets dynamically injected JSON data without having to make another round-trip request to the server to get that data on the frontend. This is a common pattern for client-side rendered apps.\n\n## CRUD API Routes\n\nThis app has two CRUD API routes: for reading and inserting into the messages table. They both speak JSON, which is standard. They import their functions from `/backend/database/queries.ts`. This routes are called from the React app to refresh and update data.\n\n## Errors\n\nHono and other API frameworks have a habit of swallowing up Errors. We turn off this default behavior by re-throwing errors, because we think most of the time you'll want to see the full stack trace instead of merely \"Internal Server Error\". You can customize how you want errors to appear.",[151,237],{"_106":459,"_155":138,"_152":411,"_99":237,"_162":412,"_160":205,"_103":33,"_154":371,"_108":460,"_156":157,"_164":-5,"_158":27,"_163":27,"_102":461},"6dd3d69a-f453-11ef-bc06-569c3dd06744",["D",1740582463346],[151,372,237],"page","hasNext","routes/_app","actionData","errors"]

History