starter-svelte's Introduction

About the project

npx degit OllieJT/starter-svelte

This is a SvelteKit project. You'll need node setup before you begin.

# install dependencies
npm install

Developing

Once you've created a project and installed dependencies with npm install (or pnpm install or yarn), start a development server:

npm run dev

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

To create a production version of your app:

npm run build

Syntax	Description
`dev`	starts dev server
`build`	build app for production
`check`	checks project for best practices
`format`	format files with Prettier
`lint`	checks for linting and formatting issues with Prettier & Eslint
`ts`	checks for typescript errors

Package	Description
Svelte	Frontend framework
Svelte Kit	Fullstack meta-framework
sveltekit-superforms	Easy form data handling with type-safety
zod	Runtime type checking
date-fns	Easy date formatting and utilities

// KEY: Comment details

Key	Description
BUG	Highlights a known bug in the code that needs fixing.
HACK	Indicates that a certain piece of code is a workaround or a temporary solution that bypasses the issue rather than solving it.
FIXME	A section of code that doesn't work as it should and needs to be fixed.
TODO	A reminder that there is some piece of code or functionality that still needs to be implemented or finished.
FEAT	A section where a new feature needs to be implemented.
[ ]	An incomplete checklist item. Typically used for subtasks within a larger project.
[x]	An complete checklist item.

Recommend Projects