routify-starter

Starter template for Routify.

Get started

Starter templates

Template Description
master Default template, includes examples folder
blog Generates a blog from local markdown posts. Includes mdsvex
auth Embedded login on protected pages. Includes Auth0

To use a template, run:

npx @sveltech/routify init

or

npx @sveltech/routify init --branch <branch-name>

The above commands will populate the current directory, they don't create a new one.

npm scripts

Syntax Description
dev Development (port 5000)
dev:nollup Development with crazy fast rebuilds (port 5000)
dev-dynamic Development with dynamic imports
build Build a bundled app with SSR + prerendering and dynamic imports
serve Run after a build to preview. Serves SPA on 5000 and SSR on 5005
deploy:* Deploy to netlify or now
export Create static pages from content in dist folder (used by npm run build)

SSR and pre-rendering

SSR and pre-rendering are included in the default build process.

npm run deploy:(now|netlify) will deploy the app with SSR and prerendering included.

To render async data, call the $ready() helper whenever your data is ready.

If $ready() is present, rendering will be delayed till the function has been called.

Otherwise it will be rendered instantly.

See src/pages/example/api/[showId].svelte for an example.

Production

  • For SPA or SSR apps please make sure that url rewrite is enabled on the server.
  • For SPA redirect to __app.html.
  • For SSR redirect to the lambda function or express server.

Typescript

For Typescript, we recommend @lamualfa excellent routify-ts

New project: npx routify-ts init <project-name> [routify-init-args]

Existing project: npx routify-ts convert [project-directory]

Issues?

File on Github! See https://github.com/sveltech/routify/issues .