Skip to content

Latest commit

 

History

History
50 lines (38 loc) · 1.78 KB

README.md

File metadata and controls

50 lines (38 loc) · 1.78 KB
Raw

Base Rollup/Svelte/Sass Starter Template

A template for rollup, svelte, and sass.

Getting Started:

  1. Clone Template with degit.
  2. Update package.json
  3. Set "name" in package.json.
  4. Replace Default PORT in package.json 'start' script (${PORT:-7000})
  5. Update index.html
  6. If you want a font other than Roboto update (or delete) the Google Fonts <link>.
  7. Create each a file in 'src/assets' for each favicon referenced in index.html.
  8. Delete unwanted linked assets or meta tags.
  9. Delete TODOs.
  10. Update app.scss
  11. If you've changed the font in index.html, update app.scss to match.
  12. Delete TODOs.
  13. Run npm install.
  14. Run git init and git add remote origin URL_TO_ORIGIN (fix URL first).
  15. Run `git commit -m 'Initial Commit'

Using:

  1. Run npm run dev to start a server with watching for app changes.
  2. If you change index.html you'll need to restart your server.
  3. If you want to run on a non-default port run PORT=NEW_PORT npm run dev
  4. Any files or folders in assets will be copied into public.
  5. Any files referenced by app.scss will be built into public.
  6. Any files referenced by app.js will be build into public.

Prod:

  1. Run npm run build to copy and build all assets and hash the javascript and css built.

Deploy:

Configure s3 or cloudflare to server all files with a very aggressive cache. The content hashing will bust the caching for updated js and css files.

You'll want to serve all files with heavy caching except index.html (which should never be cached) and any icons or images from src/assets (unless you version these manually).

On CI server the steps to deploy will be roughly:

  1. Use a recent node version.
  2. npm install && npm run build.
  3. Copy public folder to somethign like s3 or cloudflare.