v1.41.1 - Static Assets API in Encore.ts

[marcuskohlberg]

Encore.ts now comes with built-in support for serving static assets (such as images, HTML and CSS files, and JavaScript files).
This is useful when you want to serve a static website or a single-page application (SPA) that has been pre-compiled into static files.

When defining static files, the files are served directly from the Encore.ts Rust Runtime. This means that zero JavaScript code is executed to serve the files, freeing up the Node.js runtime to focus on executing business logic. This dramatically speeds up both the static file serving, as well as improving the latency of your API endpoints.⚡️

Learn more in the docs
Example app showing how to serve static files

Example

Serving static files in Encore.ts works similarly to regular API endpoints, but using the api.static function instead.

import { api } from "encore.dev/api";

export const assets = api.static(
  { expose: true, path: "/frontend/*path", dir: "./assets" },
);

This will serve all files in the ./assets directory under the /frontend path prefix.

Encore automatically serves index.html files at the root of a directory. In the case above, that means that requesting the URL /frontend will serve the file ./assets/index.html, and /frontend/hello will serve the file ./assets/hello or ./assets/hello/index.html (whichever exists).

Other improvements & bug fixes

• Update rest-api.mdx by @marcuskohlberg in Update rest-api.mdx #1354
• clientgen: skip streaming endpoints in unsupported langs by @fredr in clientgen: skip streaming endpoints in unsupported langs #1355
• Clean up the benefits/overview docs to be more to the point by @marcuskohlberg in Clean up the benefits/overview docs to be more to the point #1358
• clientgen: properly close getAuthData when no auth by @fredr in clientgen: properly close getAuthData when no auth #1361
• Corrected typo in index.mdx by @azharsamdani in Corrected typo in index.mdx #1360
• clientgen: more idiomatic empty return by @fredr in clientgen: more idiomatic empty return #1362
• runtimes/js: export raw request types by @eandre in runtimes/js: export raw request types #1363
• tsparser: set streaming field for test handlers by @eandre in tsparser: set streaming field for test handlers #1364
• cli: refactor file watching logic by @eandre in cli: refactor file watching logic #1357
• fix: increase timeout for api client generation by @melkstam in fix: increase timeout for api client generation #1356
• Fixes to document structure in Express.js migration guide by @simon-johansson in Fixes to document structure in Express.js migration guide #1365
• Encore.ts API docs refactoring by @marcuskohlberg in Encore.ts API docs refactoring #1359
• Fix line breaks in api documentation by @marcuskohlberg in Fix line breaks in api documentation #1366
• runtimes/core: handle handshake request with only path params by @fredr in runtimes/core: handle handshake request with only path params #1368
• runtimes/js: fix nodejs socket compatibility by @eandre in runtimes/js: fix nodejs socket compatibility #1370
• chore: Update streaming API documentation by @trueshizus in chore: Update streaming API documentation #1367
• Additions to the streaming api docs by @simon-johansson in Additions to the streaming api docs #1371
• Add how to guide about using NestJS with Encore by @simon-johansson in Add how to guide about using NestJS with Encore #1272
• runtimes/js: support Buffer in db queries by @eandre in runtimes/js: support Buffer in db queries #1372
• runtimes/js: don't destroy stream after done by @eandre in runtimes/js: don't destroy stream after done #1376
• Encore.Go Docs refactor by @marcuskohlberg in Encore.Go Docs refactor #1369
• change filename to fix broken link by @marcuskohlberg in change filename to fix broken link #1379
• runtimes/js: add api.static for serving static files by @eandre in runtimes/js: add api.static for serving static files #1378
• Fix docs menu syntax, improve static asset parsing by @eandre in Fix docs menu syntax, improve static asset parsing #1381
• cli: increase app creation timeout by @eandre in cli: increase app creation timeout #1382
• Add file upload docs by @simon-johansson in Add file upload docs #1380
• Fix metadata variable names by @simon-johansson in Fix metadata variable names #1375
• Add links to GitHub for related examples by @simon-johansson in Add links to GitHub for related examples #1384
• Add related examples to more docs pages by @marcuskohlberg in Add related examples to more docs pages #1386

Thanks to our New Contributors ❤️

• @azharsamdani made their first contribution in Corrected typo in index.mdx #1360
• @trueshizus made their first contribution in chore: Update streaming API documentation #1367

Full Changelog: v1.40.0...v1.41.0

---

This discussion was created from the release v1.41.1 - Static Assets API in Encore.ts.