Sapper bootstrap
This commit is contained in:
commit
8b6cd87f50
3
.gitattributes
vendored
Normal file
3
.gitattributes
vendored
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
static/**/**.png filter=lfs diff=lfs merge=lfs -text
|
||||||
|
static/**/**.jpg filter=lfs diff=lfs merge=lfs -text
|
||||||
|
static/**/**.gif filter=lfs diff=lfs merge=lfs -text
|
6
.gitignore
vendored
Normal file
6
.gitignore
vendored
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
.DS_Store
|
||||||
|
/node_modules/
|
||||||
|
/src/node_modules/@sapper/
|
||||||
|
yarn-error.log
|
||||||
|
/cypress/screenshots/
|
||||||
|
/__sapper__/
|
88
README.md
Normal file
88
README.md
Normal file
@ -0,0 +1,88 @@
|
|||||||
|
# sapper-template
|
||||||
|
|
||||||
|
The default [Sapper](https://github.com/sveltejs/sapper) template, with branches for Rollup and webpack. To clone it and get started:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# for Rollup
|
||||||
|
npx degit "sveltejs/sapper-template#rollup" my-app
|
||||||
|
# for webpack
|
||||||
|
npx degit "sveltejs/sapper-template#webpack" my-app
|
||||||
|
cd my-app
|
||||||
|
npm install # or yarn!
|
||||||
|
npm run dev
|
||||||
|
```
|
||||||
|
|
||||||
|
Open up [localhost:3000](http://localhost:3000) and start clicking around.
|
||||||
|
|
||||||
|
Consult [sapper.svelte.dev](https://sapper.svelte.dev) for help getting started.
|
||||||
|
|
||||||
|
|
||||||
|
## Structure
|
||||||
|
|
||||||
|
Sapper expects to find two directories in the root of your project — `src` and `static`.
|
||||||
|
|
||||||
|
|
||||||
|
### src
|
||||||
|
|
||||||
|
The [src](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.
|
||||||
|
|
||||||
|
|
||||||
|
#### src/routes
|
||||||
|
|
||||||
|
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.svelte` corresponds to the `/about` route. A file called `src/routes/blog/[slug].svelte` corresponds to the `/blog/:slug` route, in which case `params.slug` is available to the route
|
||||||
|
* The file `src/routes/index.svelte` (or `src/routes/index.js`) corresponds to the root of your app. `src/routes/about/index.svelte` is treated the same as `src/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.js` and it would *not* create a `/_helpers/datetime` route
|
||||||
|
|
||||||
|
|
||||||
|
### static
|
||||||
|
|
||||||
|
The [static](static) directory contains any static assets that should be available. These are served using [sirv](https://github.com/lukeed/sirv).
|
||||||
|
|
||||||
|
In your [service-worker.js](app/service-worker.js) file, you can import these as `files` from the generated manifest...
|
||||||
|
|
||||||
|
```js
|
||||||
|
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).
|
||||||
|
|
||||||
|
|
||||||
|
## Bundler config
|
||||||
|
|
||||||
|
Sapper uses Rollup or webpack to provide code-splitting and dynamic imports, as well as compiling your Svelte components. With webpack, it also provides hot module reloading. As long as you don't do anything daft, you can edit the configuration files to add whatever plugins you'd like.
|
||||||
|
|
||||||
|
|
||||||
|
## Production mode and deployment
|
||||||
|
|
||||||
|
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](https://zeit.co/now), run these commands:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install -g now
|
||||||
|
now
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
## Using external components
|
||||||
|
|
||||||
|
When using Svelte components installed from npm, such as [@sveltejs/svelte-virtual-list](https://github.com/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](rollup.config.js) or the `externals` option in [webpack.config.js](webpack.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:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install -D @sveltejs/svelte-virtual-list
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
## Bugs and feedback
|
||||||
|
|
||||||
|
Sapper is in early development, and may have the odd rough edge here and there. Please be vocal over on the [Sapper issue tracker](https://github.com/sveltejs/sapper/issues).
|
18
appveyor.yml
Normal file
18
appveyor.yml
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
version: "{build}"
|
||||||
|
|
||||||
|
shallow_clone: true
|
||||||
|
|
||||||
|
init:
|
||||||
|
- git config --global core.autocrlf false
|
||||||
|
|
||||||
|
build: off
|
||||||
|
|
||||||
|
environment:
|
||||||
|
matrix:
|
||||||
|
# node.js
|
||||||
|
- nodejs_version: stable
|
||||||
|
|
||||||
|
install:
|
||||||
|
- ps: Install-Product node $env:nodejs_version
|
||||||
|
- npm install cypress
|
||||||
|
- npm install
|
4
cypress.json
Normal file
4
cypress.json
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
{
|
||||||
|
"baseUrl": "http://localhost:3000",
|
||||||
|
"video": false
|
||||||
|
}
|
5
cypress/fixtures/example.json
Normal file
5
cypress/fixtures/example.json
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
{
|
||||||
|
"name": "Using fixtures to represent data",
|
||||||
|
"email": "hello@cypress.io",
|
||||||
|
"body": "Fixtures are a great way to mock data for responses to routes"
|
||||||
|
}
|
19
cypress/integration/spec.js
Normal file
19
cypress/integration/spec.js
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
describe('Sapper template app', () => {
|
||||||
|
beforeEach(() => {
|
||||||
|
cy.visit('/')
|
||||||
|
});
|
||||||
|
|
||||||
|
it('has the correct <h1>', () => {
|
||||||
|
cy.contains('h1', 'Great success!')
|
||||||
|
});
|
||||||
|
|
||||||
|
it('navigates to /about', () => {
|
||||||
|
cy.get('nav a').contains('about').click();
|
||||||
|
cy.url().should('include', '/about');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('navigates to /blog', () => {
|
||||||
|
cy.get('nav a').contains('blog').click();
|
||||||
|
cy.url().should('include', '/blog');
|
||||||
|
});
|
||||||
|
});
|
17
cypress/plugins/index.js
Normal file
17
cypress/plugins/index.js
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
// ***********************************************************
|
||||||
|
// This example plugins/index.js can be used to load plugins
|
||||||
|
//
|
||||||
|
// You can change the location of this file or turn off loading
|
||||||
|
// the plugins file with the 'pluginsFile' configuration option.
|
||||||
|
//
|
||||||
|
// You can read more here:
|
||||||
|
// https://on.cypress.io/plugins-guide
|
||||||
|
// ***********************************************************
|
||||||
|
|
||||||
|
// This function is called when a project is opened or re-opened (e.g. due to
|
||||||
|
// the project's config changing)
|
||||||
|
|
||||||
|
module.exports = (on, config) => {
|
||||||
|
// `on` is used to hook into various events Cypress emits
|
||||||
|
// `config` is the resolved Cypress config
|
||||||
|
}
|
25
cypress/support/commands.js
Normal file
25
cypress/support/commands.js
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
// ***********************************************
|
||||||
|
// This example commands.js shows you how to
|
||||||
|
// create various custom commands and overwrite
|
||||||
|
// existing commands.
|
||||||
|
//
|
||||||
|
// For more comprehensive examples of custom
|
||||||
|
// commands please read more here:
|
||||||
|
// https://on.cypress.io/custom-commands
|
||||||
|
// ***********************************************
|
||||||
|
//
|
||||||
|
//
|
||||||
|
// -- This is a parent command --
|
||||||
|
// Cypress.Commands.add("login", (email, password) => { ... })
|
||||||
|
//
|
||||||
|
//
|
||||||
|
// -- This is a child command --
|
||||||
|
// Cypress.Commands.add("drag", { prevSubject: 'element'}, (subject, options) => { ... })
|
||||||
|
//
|
||||||
|
//
|
||||||
|
// -- This is a dual command --
|
||||||
|
// Cypress.Commands.add("dismiss", { prevSubject: 'optional'}, (subject, options) => { ... })
|
||||||
|
//
|
||||||
|
//
|
||||||
|
// -- This is will overwrite an existing command --
|
||||||
|
// Cypress.Commands.overwrite("visit", (originalFn, url, options) => { ... })
|
20
cypress/support/index.js
Normal file
20
cypress/support/index.js
Normal file
@ -0,0 +1,20 @@
|
|||||||
|
// ***********************************************************
|
||||||
|
// This example support/index.js is processed and
|
||||||
|
// loaded automatically before your test files.
|
||||||
|
//
|
||||||
|
// This is a great place to put global configuration and
|
||||||
|
// behavior that modifies Cypress.
|
||||||
|
//
|
||||||
|
// You can change the location of this file or turn off
|
||||||
|
// automatically serving support files with the
|
||||||
|
// 'supportFile' configuration option.
|
||||||
|
//
|
||||||
|
// You can read more here:
|
||||||
|
// https://on.cypress.io/configuration
|
||||||
|
// ***********************************************************
|
||||||
|
|
||||||
|
// Import commands.js using ES2015 syntax:
|
||||||
|
import './commands'
|
||||||
|
|
||||||
|
// Alternatively you can use CommonJS syntax:
|
||||||
|
// require('./commands')
|
26
package.json
Normal file
26
package.json
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
{
|
||||||
|
"name": "TODO",
|
||||||
|
"description": "TODO",
|
||||||
|
"version": "0.0.1",
|
||||||
|
"scripts": {
|
||||||
|
"dev": "sapper dev",
|
||||||
|
"build": "sapper build",
|
||||||
|
"export": "sapper export",
|
||||||
|
"start": "node __sapper__/build",
|
||||||
|
"cy:run": "cypress run",
|
||||||
|
"cy:open": "cypress open",
|
||||||
|
"test": "run-p --race dev cy:run"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"compression": "^1.7.1",
|
||||||
|
"polka": "^0.5.0",
|
||||||
|
"sirv": "^0.4.0"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"npm-run-all": "^4.1.5",
|
||||||
|
"sapper": "^0.27.0",
|
||||||
|
"svelte": "^3.0.0",
|
||||||
|
"svelte-loader": "^2.9.0",
|
||||||
|
"webpack": "^4.7.0"
|
||||||
|
}
|
||||||
|
}
|
5
src/client.js
Normal file
5
src/client.js
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
import * as sapper from '@sapper/app';
|
||||||
|
|
||||||
|
sapper.start({
|
||||||
|
target: document.querySelector('#sapper')
|
||||||
|
});
|
60
src/components/Nav.svelte
Normal file
60
src/components/Nav.svelte
Normal file
@ -0,0 +1,60 @@
|
|||||||
|
<script>
|
||||||
|
export let segment;
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<style>
|
||||||
|
nav {
|
||||||
|
border-bottom: 1px solid rgba(255,62,0,0.1);
|
||||||
|
font-weight: 300;
|
||||||
|
padding: 0 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
ul {
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* clearfix */
|
||||||
|
ul::after {
|
||||||
|
content: '';
|
||||||
|
display: block;
|
||||||
|
clear: both;
|
||||||
|
}
|
||||||
|
|
||||||
|
li {
|
||||||
|
display: block;
|
||||||
|
float: left;
|
||||||
|
}
|
||||||
|
|
||||||
|
.selected {
|
||||||
|
position: relative;
|
||||||
|
display: inline-block;
|
||||||
|
}
|
||||||
|
|
||||||
|
.selected::after {
|
||||||
|
position: absolute;
|
||||||
|
content: '';
|
||||||
|
width: calc(100% - 1em);
|
||||||
|
height: 2px;
|
||||||
|
background-color: rgb(255,62,0);
|
||||||
|
display: block;
|
||||||
|
bottom: -1px;
|
||||||
|
}
|
||||||
|
|
||||||
|
a {
|
||||||
|
text-decoration: none;
|
||||||
|
padding: 1em 0.5em;
|
||||||
|
display: block;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
|
||||||
|
<nav>
|
||||||
|
<ul>
|
||||||
|
<li><a class='{segment === undefined ? "selected" : ""}' href='.'>home</a></li>
|
||||||
|
<li><a class='{segment === "about" ? "selected" : ""}' href='about'>about</a></li>
|
||||||
|
|
||||||
|
<!-- for the blog link, we're using rel=prefetch so that Sapper prefetches
|
||||||
|
the blog data when we hover over the link or tap it on a touchscreen -->
|
||||||
|
<li><a rel=prefetch class='{segment === "blog" ? "selected" : ""}' href='blog'>blog</a></li>
|
||||||
|
</ul>
|
||||||
|
</nav>
|
40
src/routes/_error.svelte
Normal file
40
src/routes/_error.svelte
Normal file
@ -0,0 +1,40 @@
|
|||||||
|
<script>
|
||||||
|
export let status;
|
||||||
|
export let error;
|
||||||
|
|
||||||
|
const dev = process.env.NODE_ENV === 'development';
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<style>
|
||||||
|
h1, p {
|
||||||
|
margin: 0 auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1 {
|
||||||
|
font-size: 2.8em;
|
||||||
|
font-weight: 700;
|
||||||
|
margin: 0 0 0.5em 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
p {
|
||||||
|
margin: 1em auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (min-width: 480px) {
|
||||||
|
h1 {
|
||||||
|
font-size: 4em;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
|
||||||
|
<svelte:head>
|
||||||
|
<title>{status}</title>
|
||||||
|
</svelte:head>
|
||||||
|
|
||||||
|
<h1>{status}</h1>
|
||||||
|
|
||||||
|
<p>{error.message}</p>
|
||||||
|
|
||||||
|
{#if dev && error.stack}
|
||||||
|
<pre>{error.stack}</pre>
|
||||||
|
{/if}
|
22
src/routes/_layout.svelte
Normal file
22
src/routes/_layout.svelte
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
<script>
|
||||||
|
import Nav from '../components/Nav.svelte';
|
||||||
|
|
||||||
|
export let segment;
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<style>
|
||||||
|
main {
|
||||||
|
position: relative;
|
||||||
|
max-width: 56em;
|
||||||
|
background-color: white;
|
||||||
|
padding: 2em;
|
||||||
|
margin: 0 auto;
|
||||||
|
box-sizing: border-box;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
|
||||||
|
<Nav {segment}/>
|
||||||
|
|
||||||
|
<main>
|
||||||
|
<slot></slot>
|
||||||
|
</main>
|
7
src/routes/about.svelte
Normal file
7
src/routes/about.svelte
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
<svelte:head>
|
||||||
|
<title>About</title>
|
||||||
|
</svelte:head>
|
||||||
|
|
||||||
|
<h1>About this site</h1>
|
||||||
|
|
||||||
|
<p>This is the 'about' page. There's not much here.</p>
|
28
src/routes/blog/[slug].json.js
Normal file
28
src/routes/blog/[slug].json.js
Normal file
@ -0,0 +1,28 @@
|
|||||||
|
import posts from './_posts.js';
|
||||||
|
|
||||||
|
const lookup = new Map();
|
||||||
|
posts.forEach(post => {
|
||||||
|
lookup.set(post.slug, JSON.stringify(post));
|
||||||
|
});
|
||||||
|
|
||||||
|
export function get(req, res, next) {
|
||||||
|
// the `slug` parameter is available because
|
||||||
|
// this file is called [slug].json.js
|
||||||
|
const { slug } = req.params;
|
||||||
|
|
||||||
|
if (lookup.has(slug)) {
|
||||||
|
res.writeHead(200, {
|
||||||
|
'Content-Type': 'application/json'
|
||||||
|
});
|
||||||
|
|
||||||
|
res.end(lookup.get(slug));
|
||||||
|
} else {
|
||||||
|
res.writeHead(404, {
|
||||||
|
'Content-Type': 'application/json'
|
||||||
|
});
|
||||||
|
|
||||||
|
res.end(JSON.stringify({
|
||||||
|
message: `Not found`
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
}
|
64
src/routes/blog/[slug].svelte
Normal file
64
src/routes/blog/[slug].svelte
Normal file
@ -0,0 +1,64 @@
|
|||||||
|
<script context="module">
|
||||||
|
export async function preload({ params, query }) {
|
||||||
|
// the `slug` parameter is available because
|
||||||
|
// this file is called [slug].svelte
|
||||||
|
const res = await this.fetch(`blog/${params.slug}.json`);
|
||||||
|
const data = await res.json();
|
||||||
|
|
||||||
|
if (res.status === 200) {
|
||||||
|
return { post: data };
|
||||||
|
} else {
|
||||||
|
this.error(res.status, data.message);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<script>
|
||||||
|
export let post;
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<style>
|
||||||
|
/*
|
||||||
|
By default, CSS is locally scoped to the component,
|
||||||
|
and any unused styles are dead-code-eliminated.
|
||||||
|
In this page, Svelte can't know which elements are
|
||||||
|
going to appear inside the {{{post.html}}} block,
|
||||||
|
so we have to use the :global(...) modifier to target
|
||||||
|
all elements inside .content
|
||||||
|
*/
|
||||||
|
.content :global(h2) {
|
||||||
|
font-size: 1.4em;
|
||||||
|
font-weight: 500;
|
||||||
|
}
|
||||||
|
|
||||||
|
.content :global(pre) {
|
||||||
|
background-color: #f9f9f9;
|
||||||
|
box-shadow: inset 1px 1px 5px rgba(0,0,0,0.05);
|
||||||
|
padding: 0.5em;
|
||||||
|
border-radius: 2px;
|
||||||
|
overflow-x: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
.content :global(pre) :global(code) {
|
||||||
|
background-color: transparent;
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.content :global(ul) {
|
||||||
|
line-height: 1.5;
|
||||||
|
}
|
||||||
|
|
||||||
|
.content :global(li) {
|
||||||
|
margin: 0 0 0.5em 0;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
|
||||||
|
<svelte:head>
|
||||||
|
<title>{post.title}</title>
|
||||||
|
</svelte:head>
|
||||||
|
|
||||||
|
<h1>{post.title}</h1>
|
||||||
|
|
||||||
|
<div class='content'>
|
||||||
|
{@html post.html}
|
||||||
|
</div>
|
92
src/routes/blog/_posts.js
Normal file
92
src/routes/blog/_posts.js
Normal file
@ -0,0 +1,92 @@
|
|||||||
|
// Ordinarily, you'd generate this data from markdown files in your
|
||||||
|
// repo, or fetch them from a database of some kind. But in order to
|
||||||
|
// avoid unnecessary dependencies in the starter template, and in the
|
||||||
|
// service of obviousness, we're just going to leave it here.
|
||||||
|
|
||||||
|
// This file is called `_posts.js` rather than `posts.js`, because
|
||||||
|
// we don't want to create an `/blog/posts` route — the leading
|
||||||
|
// underscore tells Sapper not to do that.
|
||||||
|
|
||||||
|
const posts = [
|
||||||
|
{
|
||||||
|
title: 'What is Sapper?',
|
||||||
|
slug: 'what-is-sapper',
|
||||||
|
html: `
|
||||||
|
<p>First, you have to know what <a href='https://svelte.dev'>Svelte</a> is. Svelte is a UI framework with a bold new idea: rather than providing a library that you write code with (like React or Vue, for example), it's a compiler that turns your components into highly optimized vanilla JavaScript. If you haven't already read the <a href='https://svelte.dev/blog/frameworks-without-the-framework'>introductory blog post</a>, you should!</p>
|
||||||
|
|
||||||
|
<p>Sapper is a Next.js-style framework (<a href='blog/how-is-sapper-different-from-next'>more on that here</a>) built around Svelte. It makes it embarrassingly easy to create extremely high performance web apps. Out of the box, you get:</p>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>Code-splitting, dynamic imports and hot module replacement, powered by webpack</li>
|
||||||
|
<li>Server-side rendering (SSR) with client-side hydration</li>
|
||||||
|
<li>Service worker for offline support, and all the PWA bells and whistles</li>
|
||||||
|
<li>The nicest development experience you've ever had, or your money back</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<p>It's implemented as Express middleware. Everything is set up and waiting for you to get started, but you keep complete control over the server, service worker, webpack config and everything else, so it's as flexible as you need it to be.</p>
|
||||||
|
`
|
||||||
|
},
|
||||||
|
|
||||||
|
{
|
||||||
|
title: 'How to use Sapper',
|
||||||
|
slug: 'how-to-use-sapper',
|
||||||
|
html: `
|
||||||
|
<h2>Step one</h2>
|
||||||
|
<p>Create a new project, using <a href='https://github.com/Rich-Harris/degit'>degit</a>:</p>
|
||||||
|
|
||||||
|
<pre><code>npx degit "sveltejs/sapper-template#rollup" my-app
|
||||||
|
cd my-app
|
||||||
|
npm install # or yarn!
|
||||||
|
npm run dev
|
||||||
|
</code></pre>
|
||||||
|
|
||||||
|
<h2>Step two</h2>
|
||||||
|
<p>Go to <a href='http://localhost:3000'>localhost:3000</a>. Open <code>my-app</code> in your editor. Edit the files in the <code>src/routes</code> directory or add new ones.</p>
|
||||||
|
|
||||||
|
<h2>Step three</h2>
|
||||||
|
<p>...</p>
|
||||||
|
|
||||||
|
<h2>Step four</h2>
|
||||||
|
<p>Resist overdone joke formats.</p>
|
||||||
|
`
|
||||||
|
},
|
||||||
|
|
||||||
|
{
|
||||||
|
title: 'Why the name?',
|
||||||
|
slug: 'why-the-name',
|
||||||
|
html: `
|
||||||
|
<p>In war, the soldiers who build bridges, repair roads, clear minefields and conduct demolitions — all under combat conditions — are known as <em>sappers</em>.</p>
|
||||||
|
|
||||||
|
<p>For web developers, the stakes are generally lower than those for combat engineers. But we face our own hostile environment: underpowered devices, poor network connections, and the complexity inherent in front-end engineering. Sapper, which is short for <strong>S</strong>velte <strong>app</strong> mak<strong>er</strong>, is your courageous and dutiful ally.</p>
|
||||||
|
`
|
||||||
|
},
|
||||||
|
|
||||||
|
{
|
||||||
|
title: 'How is Sapper different from Next.js?',
|
||||||
|
slug: 'how-is-sapper-different-from-next',
|
||||||
|
html: `
|
||||||
|
<p><a href='https://github.com/zeit/next.js'>Next.js</a> is a React framework from <a href='https://zeit.co'>Zeit</a>, and is the inspiration for Sapper. There are a few notable differences, however:</p>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>It's powered by <a href='https://svelte.dev'>Svelte</a> instead of React, so it's faster and your apps are smaller</li>
|
||||||
|
<li>Instead of route masking, we encode route parameters in filenames. For example, the page you're looking at right now is <code>src/routes/blog/[slug].html</code></li>
|
||||||
|
<li>As well as pages (Svelte components, which render on server or client), you can create <em>server routes</em> in your <code>routes</code> directory. These are just <code>.js</code> files that export functions corresponding to HTTP methods, and receive Express <code>request</code> and <code>response</code> objects as arguments. This makes it very easy to, for example, add a JSON API such as the one <a href='blog/how-is-sapper-different-from-next.json'>powering this very page</a></li>
|
||||||
|
<li>Links are just <code><a></code> elements, rather than framework-specific <code><Link></code> components. That means, for example, that <a href='blog/how-can-i-get-involved'>this link right here</a>, despite being inside a blob of HTML, works with the router as you'd expect.</li>
|
||||||
|
</ul>
|
||||||
|
`
|
||||||
|
},
|
||||||
|
|
||||||
|
{
|
||||||
|
title: 'How can I get involved?',
|
||||||
|
slug: 'how-can-i-get-involved',
|
||||||
|
html: `
|
||||||
|
<p>We're so glad you asked! Come on over to the <a href='https://github.com/sveltejs/svelte'>Svelte</a> and <a href='https://github.com/sveltejs/sapper'>Sapper</a> repos, and join us in the <a href='https://svelte.dev/chat'>Discord chatroom</a>. Everyone is welcome, especially you!</p>
|
||||||
|
`
|
||||||
|
}
|
||||||
|
];
|
||||||
|
|
||||||
|
posts.forEach(post => {
|
||||||
|
post.html = post.html.replace(/^\t{3}/gm, '');
|
||||||
|
});
|
||||||
|
|
||||||
|
export default posts;
|
16
src/routes/blog/index.json.js
Normal file
16
src/routes/blog/index.json.js
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
import posts from './_posts.js';
|
||||||
|
|
||||||
|
const contents = JSON.stringify(posts.map(post => {
|
||||||
|
return {
|
||||||
|
title: post.title,
|
||||||
|
slug: post.slug
|
||||||
|
};
|
||||||
|
}));
|
||||||
|
|
||||||
|
export function get(req, res) {
|
||||||
|
res.writeHead(200, {
|
||||||
|
'Content-Type': 'application/json'
|
||||||
|
});
|
||||||
|
|
||||||
|
res.end(contents);
|
||||||
|
}
|
34
src/routes/blog/index.svelte
Normal file
34
src/routes/blog/index.svelte
Normal file
@ -0,0 +1,34 @@
|
|||||||
|
<script context="module">
|
||||||
|
export function preload({ params, query }) {
|
||||||
|
return this.fetch(`blog.json`).then(r => r.json()).then(posts => {
|
||||||
|
return { posts };
|
||||||
|
});
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<script>
|
||||||
|
export let posts;
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<style>
|
||||||
|
ul {
|
||||||
|
margin: 0 0 1em 0;
|
||||||
|
line-height: 1.5;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
|
||||||
|
<svelte:head>
|
||||||
|
<title>Blog</title>
|
||||||
|
</svelte:head>
|
||||||
|
|
||||||
|
<h1>Recent posts</h1>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
{#each posts as post}
|
||||||
|
<!-- we're using the non-standard `rel=prefetch` attribute to
|
||||||
|
tell Sapper to load the data for the page as soon as
|
||||||
|
the user hovers over the link or taps it, instead of
|
||||||
|
waiting for the 'click' event -->
|
||||||
|
<li><a rel='prefetch' href='blog/{post.slug}'>{post.title}</a></li>
|
||||||
|
{/each}
|
||||||
|
</ul>
|
46
src/routes/index.svelte
Normal file
46
src/routes/index.svelte
Normal file
@ -0,0 +1,46 @@
|
|||||||
|
<style>
|
||||||
|
h1, figure, p {
|
||||||
|
text-align: center;
|
||||||
|
margin: 0 auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1 {
|
||||||
|
font-size: 2.8em;
|
||||||
|
text-transform: uppercase;
|
||||||
|
font-weight: 700;
|
||||||
|
margin: 0 0 0.5em 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
figure {
|
||||||
|
margin: 0 0 1em 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
img {
|
||||||
|
width: 100%;
|
||||||
|
max-width: 400px;
|
||||||
|
margin: 0 0 1em 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
p {
|
||||||
|
margin: 1em auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (min-width: 480px) {
|
||||||
|
h1 {
|
||||||
|
font-size: 4em;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
|
||||||
|
<svelte:head>
|
||||||
|
<title>Sapper project template</title>
|
||||||
|
</svelte:head>
|
||||||
|
|
||||||
|
<h1>Great success!</h1>
|
||||||
|
|
||||||
|
<figure>
|
||||||
|
<img alt='Borat' src='great-success.png'>
|
||||||
|
<figcaption>HIGH FIVE!</figcaption>
|
||||||
|
</figure>
|
||||||
|
|
||||||
|
<p><strong>Try editing this file (src/routes/index.svelte) to test live reloading.</strong></p>
|
17
src/server.js
Normal file
17
src/server.js
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
import sirv from 'sirv';
|
||||||
|
import polka from 'polka';
|
||||||
|
import compression from 'compression';
|
||||||
|
import * as sapper from '@sapper/server';
|
||||||
|
|
||||||
|
const { PORT, NODE_ENV } = process.env;
|
||||||
|
const dev = NODE_ENV === 'development';
|
||||||
|
|
||||||
|
polka() // You can also use Express
|
||||||
|
.use(
|
||||||
|
compression({ threshold: 0 }),
|
||||||
|
sirv('static', { dev }),
|
||||||
|
sapper.middleware()
|
||||||
|
)
|
||||||
|
.listen(PORT, err => {
|
||||||
|
if (err) console.log('error', err);
|
||||||
|
});
|
82
src/service-worker.js
Normal file
82
src/service-worker.js
Normal file
@ -0,0 +1,82 @@
|
|||||||
|
import { timestamp, files, shell, routes } from '@sapper/service-worker';
|
||||||
|
|
||||||
|
const ASSETS = `cache${timestamp}`;
|
||||||
|
|
||||||
|
// `shell` is an array of all the files generated by the bundler,
|
||||||
|
// `files` is an array of everything in the `static` directory
|
||||||
|
const to_cache = shell.concat(files);
|
||||||
|
const cached = new Set(to_cache);
|
||||||
|
|
||||||
|
self.addEventListener('install', event => {
|
||||||
|
event.waitUntil(
|
||||||
|
caches
|
||||||
|
.open(ASSETS)
|
||||||
|
.then(cache => cache.addAll(to_cache))
|
||||||
|
.then(() => {
|
||||||
|
self.skipWaiting();
|
||||||
|
})
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
self.addEventListener('activate', event => {
|
||||||
|
event.waitUntil(
|
||||||
|
caches.keys().then(async keys => {
|
||||||
|
// delete old caches
|
||||||
|
for (const key of keys) {
|
||||||
|
if (key !== ASSETS) await caches.delete(key);
|
||||||
|
}
|
||||||
|
|
||||||
|
self.clients.claim();
|
||||||
|
})
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
self.addEventListener('fetch', event => {
|
||||||
|
if (event.request.method !== 'GET' || event.request.headers.has('range')) return;
|
||||||
|
|
||||||
|
const url = new URL(event.request.url);
|
||||||
|
|
||||||
|
// don't try to handle e.g. data: URIs
|
||||||
|
if (!url.protocol.startsWith('http')) return;
|
||||||
|
|
||||||
|
// ignore dev server requests
|
||||||
|
if (url.hostname === self.location.hostname && url.port !== self.location.port) return;
|
||||||
|
|
||||||
|
// always serve static files and bundler-generated assets from cache
|
||||||
|
if (url.host === self.location.host && cached.has(url.pathname)) {
|
||||||
|
event.respondWith(caches.match(event.request));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// for pages, you might want to serve a shell `service-worker-index.html` file,
|
||||||
|
// which Sapper has generated for you. It's not right for every
|
||||||
|
// app, but if it's right for yours then uncomment this section
|
||||||
|
/*
|
||||||
|
if (url.origin === self.origin && routes.find(route => route.pattern.test(url.pathname))) {
|
||||||
|
event.respondWith(caches.match('/service-worker-index.html'));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
*/
|
||||||
|
|
||||||
|
if (event.request.cache === 'only-if-cached') return;
|
||||||
|
|
||||||
|
// for everything else, try the network first, falling back to
|
||||||
|
// cache if the user is offline. (If the pages never change, you
|
||||||
|
// might prefer a cache-first approach to a network-first one.)
|
||||||
|
event.respondWith(
|
||||||
|
caches
|
||||||
|
.open(`offline${timestamp}`)
|
||||||
|
.then(async cache => {
|
||||||
|
try {
|
||||||
|
const response = await fetch(event.request);
|
||||||
|
cache.put(event.request, response.clone());
|
||||||
|
return response;
|
||||||
|
} catch(err) {
|
||||||
|
const response = await cache.match(event.request);
|
||||||
|
if (response) return response;
|
||||||
|
|
||||||
|
throw err;
|
||||||
|
}
|
||||||
|
})
|
||||||
|
);
|
||||||
|
});
|
33
src/template.html
Normal file
33
src/template.html
Normal file
@ -0,0 +1,33 @@
|
|||||||
|
<!doctype html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset='utf-8'>
|
||||||
|
<meta name='viewport' content='width=device-width,initial-scale=1.0'>
|
||||||
|
<meta name='theme-color' content='#333333'>
|
||||||
|
|
||||||
|
%sapper.base%
|
||||||
|
|
||||||
|
<link rel='stylesheet' href='global.css'>
|
||||||
|
<link rel='manifest' href='manifest.json'>
|
||||||
|
<link rel='icon' type='image/png' href='favicon.png'>
|
||||||
|
|
||||||
|
<!-- Sapper generates a <style> tag containing critical CSS
|
||||||
|
for the current page. CSS for the rest of the app is
|
||||||
|
lazily loaded when it precaches secondary pages -->
|
||||||
|
%sapper.styles%
|
||||||
|
|
||||||
|
<!-- This contains the contents of the <svelte:head> component, if
|
||||||
|
the current page has one -->
|
||||||
|
%sapper.head%
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<!-- The application will be rendered inside this element,
|
||||||
|
because `app/client.js` references it -->
|
||||||
|
<div id='sapper'>%sapper.html%</div>
|
||||||
|
|
||||||
|
<!-- Sapper creates a <script> tag containing `app/client.js`
|
||||||
|
and anything else it needs to hydrate the app and
|
||||||
|
initialise the router -->
|
||||||
|
%sapper.scripts%
|
||||||
|
</body>
|
||||||
|
</html>
|
BIN
static/favicon.png
(Stored with Git LFS)
Normal file
BIN
static/favicon.png
(Stored with Git LFS)
Normal file
Binary file not shown.
36
static/global.css
Normal file
36
static/global.css
Normal file
@ -0,0 +1,36 @@
|
|||||||
|
body {
|
||||||
|
margin: 0;
|
||||||
|
font-family: Roboto, -apple-system, BlinkMacSystemFont, Segoe UI, Oxygen, Ubuntu, Cantarell, Fira Sans, Droid Sans, Helvetica Neue, sans-serif;
|
||||||
|
font-size: 14px;
|
||||||
|
line-height: 1.5;
|
||||||
|
color: #333;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1, h2, h3, h4, h5, h6 {
|
||||||
|
margin: 0 0 0.5em 0;
|
||||||
|
font-weight: 400;
|
||||||
|
line-height: 1.2;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1 {
|
||||||
|
font-size: 2em;
|
||||||
|
}
|
||||||
|
|
||||||
|
a {
|
||||||
|
color: inherit;
|
||||||
|
}
|
||||||
|
|
||||||
|
code {
|
||||||
|
font-family: menlo, inconsolata, monospace;
|
||||||
|
font-size: calc(1em - 2px);
|
||||||
|
color: #555;
|
||||||
|
background-color: #f0f0f0;
|
||||||
|
padding: 0.2em 0.4em;
|
||||||
|
border-radius: 2px;
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (min-width: 400px) {
|
||||||
|
body {
|
||||||
|
font-size: 16px;
|
||||||
|
}
|
||||||
|
}
|
BIN
static/great-success.png
(Stored with Git LFS)
Normal file
BIN
static/great-success.png
(Stored with Git LFS)
Normal file
Binary file not shown.
BIN
static/logo-192.png
(Stored with Git LFS)
Normal file
BIN
static/logo-192.png
(Stored with Git LFS)
Normal file
Binary file not shown.
BIN
static/logo-512.png
(Stored with Git LFS)
Normal file
BIN
static/logo-512.png
(Stored with Git LFS)
Normal file
Binary file not shown.
20
static/manifest.json
Normal file
20
static/manifest.json
Normal file
@ -0,0 +1,20 @@
|
|||||||
|
{
|
||||||
|
"background_color": "#ffffff",
|
||||||
|
"theme_color": "#333333",
|
||||||
|
"name": "TODO",
|
||||||
|
"short_name": "TODO",
|
||||||
|
"display": "minimal-ui",
|
||||||
|
"start_url": "/",
|
||||||
|
"icons": [
|
||||||
|
{
|
||||||
|
"src": "logo-192.png",
|
||||||
|
"sizes": "192x192",
|
||||||
|
"type": "image/png"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"src": "logo-512.png",
|
||||||
|
"sizes": "512x512",
|
||||||
|
"type": "image/png"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
75
webpack.config.js
Normal file
75
webpack.config.js
Normal file
@ -0,0 +1,75 @@
|
|||||||
|
const webpack = require('webpack');
|
||||||
|
const config = require('sapper/config/webpack.js');
|
||||||
|
const pkg = require('./package.json');
|
||||||
|
|
||||||
|
const mode = process.env.NODE_ENV;
|
||||||
|
const dev = mode === 'development';
|
||||||
|
|
||||||
|
const extensions = ['.mjs', '.js', '.json', '.svelte', '.html'];
|
||||||
|
const mainFields = ['svelte', 'module', 'browser', 'main'];
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
client: {
|
||||||
|
entry: config.client.entry(),
|
||||||
|
output: config.client.output(),
|
||||||
|
resolve: { extensions, mainFields },
|
||||||
|
module: {
|
||||||
|
rules: [
|
||||||
|
{
|
||||||
|
test: /\.(svelte|html)$/,
|
||||||
|
use: {
|
||||||
|
loader: 'svelte-loader',
|
||||||
|
options: {
|
||||||
|
dev,
|
||||||
|
hydratable: true,
|
||||||
|
hotReload: false // pending https://github.com/sveltejs/svelte/issues/2377
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
mode,
|
||||||
|
plugins: [
|
||||||
|
// pending https://github.com/sveltejs/svelte/issues/2377
|
||||||
|
// dev && new webpack.HotModuleReplacementPlugin(),
|
||||||
|
new webpack.DefinePlugin({
|
||||||
|
'process.browser': true,
|
||||||
|
'process.env.NODE_ENV': JSON.stringify(mode)
|
||||||
|
}),
|
||||||
|
].filter(Boolean),
|
||||||
|
devtool: dev && 'inline-source-map'
|
||||||
|
},
|
||||||
|
|
||||||
|
server: {
|
||||||
|
entry: config.server.entry(),
|
||||||
|
output: config.server.output(),
|
||||||
|
target: 'node',
|
||||||
|
resolve: { extensions, mainFields },
|
||||||
|
externals: Object.keys(pkg.dependencies).concat('encoding'),
|
||||||
|
module: {
|
||||||
|
rules: [
|
||||||
|
{
|
||||||
|
test: /\.(svelte|html)$/,
|
||||||
|
use: {
|
||||||
|
loader: 'svelte-loader',
|
||||||
|
options: {
|
||||||
|
css: false,
|
||||||
|
generate: 'ssr',
|
||||||
|
dev
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
mode: process.env.NODE_ENV,
|
||||||
|
performance: {
|
||||||
|
hints: false // it doesn't matter if server.js is large
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
serviceworker: {
|
||||||
|
entry: config.serviceworker.entry(),
|
||||||
|
output: config.serviceworker.output(),
|
||||||
|
mode: process.env.NODE_ENV
|
||||||
|
}
|
||||||
|
};
|
Loading…
Reference in New Issue
Block a user