A Modified Sapper template, available for Rollup. Automagically generates pages, sub-pages/subroutes, and navigation using only folders and Markdown files.
degit is a scaffolding tool that lets you create a directory from a branch in a repository:
npx degit "marcebdev/sapper-dynamic-template#master" my-appAlternatively, you can use GitHub's template feature with the sapper-dynamic-template repository.
However you get the code, you can install dependencies and run the project in development mode with:
cd my-app
npm install # or yarn
npm run devOpen up localhost:3000 and start clicking around.
Consult sapper.svelte.dev for help getting started.
Sapper expects to find two directories in the root of your project — src and static.
The src directory contains the entry points for your app — client.js, server.js and (optionally) a service-worker.js — along with a template.html file and a routes directory.
This is the heart of your Sapper app. There are two kinds of routes — pages, and server routes.
Pages are Svelte components written in .svelte files. When a user first visits the application, they will be served a server-rendered version of the route in question, plus some JavaScript that 'hydrates' the page and initialises a client-side router. From that point forward, navigating to other pages is handled entirely on the client for a fast, app-like feel. (Sapper will preload and cache the code for these subsequent pages, so that navigation is instantaneous.)
Server routes are modules written in .js files, that export functions corresponding to HTTP methods. Each function receives Express request and response objects as arguments, plus a next function. This is useful for creating a JSON API, for example.
There are three simple rules for naming the files that define your routes:
- A file called
src/routes/about.sveltecorresponds to the/aboutroute. A file calledsrc/routes/blog/[slug].sveltecorresponds to the/blog/:slugroute, in which caseparams.slugis available to the route - The file
src/routes/index.svelte(orsrc/routes/index.js) corresponds to the root of your app.src/routes/about/index.svelteis treated the same assrc/routes/about.svelte. - Files and directories with a leading underscore do not create routes. This allows you to colocate helper modules and components with the routes that depend on them — for example you could have a file called
src/routes/_helpers/datetime.jsand it would not create a/_helpers/datetimeroute
The static directory contains any static assets that should be available. These are served using sirv.
In your service-worker.js file, you can import these as files from the generated manifest...
import { files } from '@sapper/service-worker';...so that you can cache them (though you can choose not to, for example if you don't want to cache very large files).
To start a production version of your app, run npm run build && npm start. This will disable live reloading, and activate the appropriate bundler plugins.
You can deploy your application to any environment that supports Node 8 or above. As an example, to deploy to Now, run these commands:
npm install -g now
nowWhen using Svelte components installed from npm, such as @sveltejs/svelte-virtual-list, Svelte needs the original component source (rather than any precompiled JavaScript that ships with the component). This allows the component to be rendered server-side, and also keeps your client-side app smaller.
Because of that, it's essential that the bundler doesn't treat the package as an external dependency. You can either modify the external option under server in rollup.config.js or simply install the package to devDependencies rather than dependencies, which will cause it to get bundled (and therefore compiled) with your app:
npm install -D @sveltejs/svelte-virtual-listSapper is in early development, and may have the odd rough edge here and there. Please be vocal over on the Sapper issue tracker.