A personalized project skeleton, designed for constructing web applications utilizing SvelteKit.
It includes various pre-made configurations, including:
- Sveltekit
- Typescript
- TailwindCSS
- Prettier
- Eslint
- Editorconfig
- Docker
ghcr.io/maandr/sveltekit-starter
This project targets a containerized runtime environment. The project provides a command dockerBuild
that builds the application and bakes it into a docker image.
GitHub Action workflows are preconfigured as follows:
- - Triggers on every pull request and verifies the projects build status and code quality.
- - Triggers on every push or tag to the
main
branch and builds and pushes the docker image to the GitHub Container Registry.
❗ The
CD
workflow requires the following secrets to be configured in the repository settings:
CONTAINER_REGISTRY_PAT
: Personal Access Token for GitHub Container Registry.
To run the project on your local machine, you'll need Node.js (v21.x) installed. Begin by installing project dependencies using the following command:
pnpm install
To launch the project with hot-reloading, use:
pnpm dev --open
Before committing any changes, you might want to verify code quality and formatting with pnpm check
, and execute automated tests with pnpm test
.