This starter template is designed for developers looking to jumpstart their SvelteKit projects. It comes pre-configured with a suite of tools in aim to enforce best practices and ensure high-quality, maintainable code.
To speed up initial setup and not have deployment hassles, the unit and end-to-end (2e2) starter tests and GitHub action workflows have been removed from the main branch but retained in the with_tests branch for reference.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Ensure you have pnpm
installed on your system for efficient package management. For installation instructions, visit the official pnpm installation guide.
To install the dependencies, run the following command:
pnpm install
To start the development server, run:
pnpm dev
This will start the server and open the app in a new browser tab, and navigate to: http://localhost:5173/. Changes in the code will automatically rebuild the app and refresh the page.
To build the application for production, use:
pnpm build
noUnusedLocals
: Avoids unused variable declarations.moduleDetection
: Enhanced module detection.noUnusedParameters
: Checks for unused function parameters.verbatimModuleSyntax
: Preserves module syntax upon import.noUncheckedIndexedAccess
: Enforces checks on indexed access.types
: Includes Vitest's global type definitions.noImplicitReturns
: Ensures all code paths in a function return a value.exactOptionalPropertyTypes
: Treats optional property types as exact, not allowing undefined
when not specified.noImplicitOverride
: Requires method overrides to be explicitly marked with override
.noPropertyAccessFromIndexSignature
: Requires that properties accessed using an index signature are explicitly declared.When you use this template, try follow the checklist to update your info properly
LICENSE
as you see fitstatic
dirstatic
dirREADME.md
package.json
static/site.webmanifest
.env
under SECRET_GMAIL_PASS
and SECRET_GMAIL_USERNAME
for Nodemailer configurationI welcome contributions to this project! Here are some ways you can contribute:
This project is licensed under the MIT License. This means you are free to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the software, under the conditions that you include the original copyright notice and disclaimers in any copies of the software or substantial portions of it. For more details, please see the LICENSE file.