Skip to content
This repository has been archived by the owner on Apr 26, 2022. It is now read-only.

Latest commit

 

History

History
40 lines (28 loc) · 1.3 KB

README.md

File metadata and controls

40 lines (28 loc) · 1.3 KB
Raw

sveltekit-prismic-starter

This project is an opinionated starter kit to create a fresh website powered by SvelteKit with several preconfigured dev goodies:

  • TypeScript
  • prettier & eslint
  • Tailwind, SASS, autoprefixer & html-minifier
  • Prismic.io Headless CMS
  • Netlify adapter
  • Matomo for Statistics
  • Dynamic Sitemap generation
  • favicons done right

Your TODOs:

  • change name in package.json to your project name
  • check & replace all occurences of 'TODO' in this project for customization & setup
  • use https://realfavicongenerator.net/ to generate your favicons and put the output in /static. Override existing images.
  • verify sitemap logic and paths in src/sitemap.xml.ts

Developing

Install dependencies with npm install (or pnpm install or yarn), then start a development server:

npm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open

Building

The project is setup to be configured to be deployed to Netlify. If you want to change this, use another adapter for your target environment.

npm run build

You can preview the built app with npm run preview, regardless of whether you installed an adapter. This should not be used to serve your app in production.