Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit df1f1f1
Showing
41 changed files
with
4,079 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
.DS_Store | ||
node_modules | ||
yarn-error.log | ||
/cypress/screenshots/ | ||
/__sapper__/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
sudo: false | ||
language: node_js | ||
node_js: | ||
- "stable" | ||
env: | ||
global: | ||
- BUILD_TIMEOUT=10000 | ||
install: | ||
- npm install | ||
- npm install cypress | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
# sapper-v3 | ||
|
||
Modified v2 sapper template to work with Svelte 3. | ||
|
||
Note: Right now, sapper seems to expect a preload function to be exported from every route. | ||
|
||
To clone it and get started: | ||
|
||
```bash | ||
npx degit pngwn/sapper-v3 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.technology](https://sapper.svelte.technology) for help getting started. | ||
|
||
_[Click here for the webpack version of this template](https://github.com/sveltejs/sapper-template)_ | ||
|
||
## Structure | ||
|
||
Sapper expects to find three directories in the root of your project — `app`, `assets` and `routes`. | ||
|
||
### app | ||
|
||
The [app](app) directory contains the entry points for your app — `client.js`, `server.js` and (optionally) a `service-worker.js` — along with a `template.html` file. | ||
|
||
### assets | ||
|
||
The [assets](assets) 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 `assets` from the generated manifest... | ||
|
||
```js | ||
import { assets } from "./manifest/service-worker.js"; | ||
``` | ||
|
||
...so that you can cache them (though you can choose not to, for example if you don't want to cache very large files). | ||
|
||
### 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 `.html` 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 `routes/about.html` corresponds to the `/about` route. A file called `routes/blog/[slug].html` corresponds to the `/blog/:slug` route, in which case `params.slug` is available to the route | ||
- The file `routes/index.html` (or `routes/index.js`) corresponds to the root of your app. `routes/about/index.html` is treated the same as `routes/about.html`. | ||
- 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 `routes/_helpers/datetime.js` and it would _not_ create a `/_helpers/datetime` route | ||
|
||
## Rollup config | ||
|
||
Sapper uses Rollup to provide code-splitting and dynamic imports, as well as compiling your Svelte components. 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`. | ||
|
||
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 | ||
``` | ||
|
||
## 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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"baseUrl": "http://localhost:3000", | ||
"video": false | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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'); | ||
}); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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) => { ... }) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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') |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
{ | ||
"name": "TODO", | ||
"description": "TODO", | ||
"version": "0.0.1", | ||
"scripts": { | ||
"dev": "sapper dev", | ||
"build": "sapper build --legacy", | ||
"export": "sapper export --legacy", | ||
"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.4.0", | ||
"sirv": "^0.2.0" | ||
}, | ||
"devDependencies": { | ||
"@babel/core": "^7.0.0", | ||
"@babel/plugin-syntax-dynamic-import": "^7.0.0", | ||
"@babel/plugin-transform-runtime": "^7.0.0", | ||
"@babel/preset-env": "^7.0.0", | ||
"@babel/runtime": "^7.0.0", | ||
"chokidar": "^2.0.4", | ||
"immer": "^1.9.3", | ||
"npm-run-all": "^4.1.5", | ||
"rollup": "^0.65.2", | ||
"rollup-plugin-babel": "^4.0.2", | ||
"rollup-plugin-commonjs": "^9.1.6", | ||
"rollup-plugin-node-resolve": "^3.3.0", | ||
"rollup-plugin-replace": "^2.0.0", | ||
"rollup-plugin-svelte": "^4.2.1", | ||
"rollup-plugin-terser": "^1.0.1", | ||
"sapper": "0.25.0-alpha2", | ||
"svelte": "3.0.0-alpha12" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,93 @@ | ||
import resolve from 'rollup-plugin-node-resolve'; | ||
import replace from 'rollup-plugin-replace'; | ||
import commonjs from 'rollup-plugin-commonjs'; | ||
import svelte from 'rollup-plugin-svelte'; | ||
import babel from 'rollup-plugin-babel'; | ||
import { terser } from 'rollup-plugin-terser'; | ||
import config from 'sapper/config/rollup.js'; | ||
import pkg from './package.json'; | ||
|
||
const mode = process.env.NODE_ENV; | ||
const dev = mode === 'development'; | ||
const legacy = !!process.env.SAPPER_LEGACY_BUILD; | ||
|
||
export default { | ||
client: { | ||
input: config.client.input(), | ||
output: config.client.output(), | ||
plugins: [ | ||
replace({ | ||
'process.browser': true, | ||
'process.env.NODE_ENV': JSON.stringify(mode) | ||
}), | ||
svelte({ | ||
dev, | ||
hydratable: true, | ||
emitCss: true | ||
}), | ||
resolve(), | ||
commonjs(), | ||
|
||
legacy && babel({ | ||
extensions: ['.js', '.html'], | ||
runtimeHelpers: true, | ||
exclude: ['node_modules/@babel/**'], | ||
presets: [ | ||
['@babel/preset-env', { | ||
targets: '> 0.25%, not dead' | ||
}] | ||
], | ||
plugins: [ | ||
'@babel/plugin-syntax-dynamic-import', | ||
['@babel/plugin-transform-runtime', { | ||
useESModules: true | ||
}] | ||
] | ||
}), | ||
|
||
!dev && terser({ | ||
module: true | ||
}) | ||
], | ||
|
||
// temporary, pending Rollup 1.0 | ||
experimentalCodeSplitting: true | ||
}, | ||
|
||
server: { | ||
input: config.server.input(), | ||
output: config.server.output(), | ||
plugins: [ | ||
replace({ | ||
'process.browser': false, | ||
'process.env.NODE_ENV': JSON.stringify(mode) | ||
}), | ||
svelte({ | ||
generate: 'ssr', | ||
dev | ||
}), | ||
resolve(), | ||
commonjs() | ||
], | ||
external: Object.keys(pkg.dependencies).concat( | ||
require('module').builtinModules || Object.keys(process.binding('natives')) | ||
), | ||
|
||
// temporary, pending Rollup 1.0 | ||
experimentalCodeSplitting: true | ||
}, | ||
|
||
serviceworker: { | ||
input: config.serviceworker.input(), | ||
output: config.serviceworker.output(), | ||
plugins: [ | ||
resolve(), | ||
replace({ | ||
'process.browser': true, | ||
'process.env.NODE_ENV': JSON.stringify(mode) | ||
}), | ||
commonjs(), | ||
!dev && terser() | ||
] | ||
} | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
import * as sapper from '../__sapper__/client.js'; | ||
|
||
sapper.start({ | ||
target: document.querySelector('#sapper') | ||
}); |
Empty file.
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
<svg xmlns="http://www.w3.org/2000/svg" | ||
width="{width}" | ||
height="{height}" | ||
viewBox="0 0 24 24" | ||
aria-labelledby="{iconName}" | ||
role="presentation"> | ||
<title id="{iconName}" | ||
lang="en">{iconName} icon</title> | ||
<g fill="{iconColor}"> | ||
<slot /> | ||
</g> | ||
</svg> | ||
|
||
<script> | ||
export let iconName = "box"; | ||
export let width = 18; | ||
export let height = 18; | ||
export let iconColor = "CurrentColor"; | ||
</script> | ||
|
||
<style scoped> | ||
svg { | ||
display: inline-block; | ||
vertical-align: baseline; | ||
margin-bottom: -2px; /* yes, I'm that particular about formatting */ | ||
} | ||
</style> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
<svelte:meta namespace='svg' /> | ||
<g> | ||
<path d="M12 0c-5.5 0-10 4.5-10 10 0 7.4 9.1 13.6 9.4 13.8 0.2 0.1 0.4 0.2 0.6 0.2s0.4-0.1 0.6-0.2c0.3-0.2 9.4-6.4 9.4-13.8 0-5.5-4.5-10-10-10zM12 21.8c-1.9-1.4-8-6.4-8-11.8 0-4.4 3.6-8 8-8s8 3.6 8 8c0 5.4-6.1 10.4-8 11.8z" | ||
/> | ||
<path d="M12 6c-2.2 0-4 1.8-4 4s1.8 4 4 4c2.2 0 4-1.8 4-4s-1.8-4-4-4zM12 12c-1.1 0-2-0.9-2-2s0.9-2 2-2c1.1 0 2 0.9 2 2s-0.9 2-2 2z" | ||
/> | ||
</g> |
Oops, something went wrong.