Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/michealpearce/sapped-svelte-ts-boilerplate

A svelte boilerplate with Sapper TypeScript Sass & path resolver
https://github.com/michealpearce/sapped-svelte-ts-boilerplate

javascript nodejs rollup sapper-template sapperjs sass scss svelte svelte3 typescript

Last synced: 27 days ago
JSON representation

A svelte boilerplate with Sapper TypeScript Sass & path resolver

Awesome Lists containing this project

README 

        
# sapper-template



### Installation 



```bash

git clone https://github.com/MichealPearce/sapped-svelte-ts-boilerplate.git [name of app folder]

cd [name of app folder]

yarn install

```



## Usage

You can find a list of commands to use during development inside of `package.json` listed under `scripts`



###### Basic Command Usage

`yarn [script id]`



###### Command List

```

dev - starts dev server and wathcing for changes in the script

build - builds a production copy of your app that's ready to be deployed

export - idk, it does something though

start - starts production build

cy:run - idk what cypress is 

cy:open - I still don't know what cypress is

test - runs tests but has something to do with cypress so idk

```



## 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 with webpack



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 webpack doesn't treat the package as an _external dependency_. You can either modify the `externals` option under `server` 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).