usagizmo/webapp-template

SvelteKit x Tailwind CSS x Supabase x Turborepo (pnpm)

WebApp Template

Monorepo template for creating a web application.

Caution

Currently, markuplint do not support Svelte 5. We have manually modified pnpm-lock.yaml to forcibly use Svelte 5, which may cause issues during package updates. When updating dependencies, please refer to #f99d33 for guidance on how to correctly adjust pnpm-lock.yaml.

What's inside?

Uses

• Turborepo x pnpm
• Prettier (w/ prettier-plugin-svelte + prettier-plugin-tailwindcss)
• ESLint / CSpell
• lint-staged / husky
• GitHub Actions (Linting + Testing (Validate href and src paths))
• Execute eslint --fix and prettier when saving with VS Code

Apps and Packages

apps/

• backend
  A Supabase Local Dev / CLI.
• mockup [Demo]
  A starting point for building a static site.
  Tailwind CSS + Vanilla JS + Vitest (Check links + file names)
• web [Demo]
  A starting point for building Svelte application.
  SvelteKit (w/ Tailwind CSS)
  Supabase / Vitest

packages/

• eslint-config
  ESLint 9 (Flat Config) for JavaScript and TypeScript.
  • eslint-config-prettier
  • eslint-plugin-svelte
  • eslint-plugin-simple-import-sort
  • eslint-plugin-jsdoc

VS Code Extensions (Recommend)

• EditorConfig
• ESLint
• Prettier
• Svelte
• Tailwind CSS IntelliSense

Commands

pnpm i  # Resolve dependency packages and prepare .env files
# Then set up /.env

# Run command for each package (apps/ + packages/)
pnpm build   #
pnpm lint    # root: cspell + prettier --check
pnpm test    #
pnpm format  # root: Format project-words.txt + prettier --write

List of listening port numbers

• apps/backend/ - Supabase Local Dev / CLI
  • 54321: API / GraphQL / S3 Storage
  • 54322: DB (Postgres)
  • 54323: Studio
  • 54324: Inbucket
• apps/web/ - SvelteKit application
  • 5173: Development server
• apps/mockup/ - Static site
  • 8000: BrowserSync server
  • 49160: Express server

Registering environment variables for GitHub / Vercel

If you need to prepare GitHub / Vercel environment, you need to set all environment variables (.env items) in each service.

Breaking changes

v2.0.0

• Update Framework/Library Versions:
  • Switch to Svelte 5 (integrated with TypeScript and using the Rune)
  • Update to Tailwind CSS 4 (removed tailwind.config.js)
  • Upgrade to ESLint 9 and implement Flat Config
• Backend Change:
  • Replace Nhost with Supabase for backend services

v1.9.0

• Language and Compiler Changes:
  • Migrated codebase from JavaScript to TypeScript
  • Upgraded from Svelte 4 to Svelte 5 (Rune)
• Package Naming and Structure:
  • Custom package names now prefixed with @repo/
  • Merged eslint-config-custom-typescript into eslint-config-custom

v1.6.0

• Language Reversion and Documentation:
  • Reverted codebase from TypeScript back to JavaScript, supplementing with JSDoc for documentation

v1.0.0

• Frontend Framework Change:
  • Switched from Next.js to SvelteKit for the frontend framework in apps/web
• Repository Rebranding:
  • Renamed nextjs-template repository to webapp-template

v0.23.0

• Backend Services Integration:
  • Replaced individual Firebase and Hasura applications with a unified Nhost application in apps/nhost