Skip to content

Commit

Permalink
Init: Inital files
Browse files Browse the repository at this point in the history
  • Loading branch information
plibither8 committed Sep 4, 2020
0 parents commit d11ef32
Show file tree
Hide file tree
Showing 50 changed files with 10,519 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.routify
dist
node_modules
scripts
37 changes: 37 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
module.exports = {
env: {
browser: true,
es2020: true,
node: true,
serviceworker: true
},
extends: [
'standard'
],
parserOptions: {
ecmaVersion: 11,
sourceType: 'module'
},
plugins: [
'svelte3'
],
overrides: [
{
files: ['*.svelte'],
processor: 'svelte3/svelte3',
rules: {
'import/first': 0,
'import/no-duplicates': 0,
'import/no-mutable-exports': 0,
'no-return-assign': 0,
'no-multiple-empty-lines': ['error', {
max: 1,
maxBOF: 2,
maxEOF: 0
}]
}
}
],
rules: {
}
}
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
/node_modules/
/dist/
.DS_Store
**/.history
/src/tmp/
.routify
.netlify
8 changes: 8 additions & 0 deletions .nolluprc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
module.exports = {
hot: true,
contentBase: 'dist',
publicPath: 'build',
historyApiFallback: '__app.html',
port: 5000
// proxy: { '/': 'http://localhost:5000' } legacy. Needs spassr running.
}
5 changes: 5 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
node_modules/
/export
/dist
.DS_Store
.history
56 changes: 56 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# routify-starter

Starter template for [Routify](https://github.com/sveltech/routify)

### Get started

#### Starter templates
| Template | Description |
|-------------------------------------------|-------------------------------------------------------------|
| [master](https://example.routify.dev/) | Default template, includes examples folder |
| [blog](https://blog-example.routify.dev/) | Generates a blog from local markdown posts. Includes mdsvex |
| [auth](https://auth-example.routify.dev/) | Embedded login on protected pages. Includes Auth0 |

To use a template, run

`npx @sveltech/routify init`

or

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

### 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](https://github.com/sveltech/routify-starter/blob/master/src/pages/example/api/%5BshowId%5D.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 `__dynamic.html`.
* For SSR redirect to the lambda function or express server.

### Issues?

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

0 comments on commit d11ef32

Please sign in to comment.