https://github.com/TheOtterlord/sveltekit-bun-template

Create a Svelte app, powered by Bun
https://github.com/TheOtterlord/sveltekit-bun-template

bun svelte typescript

Last synced: about 1 month ago
JSON representation

Create a Svelte app, powered by Bun

• Host: GitHub
• URL: https://github.com/TheOtterlord/sveltekit-bun-template
• Owner: TheOtterlord
• Created: 2022-07-22T18:11:31.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-01-19T09:40:57.000Z (over 1 year ago)
• Last Synced: 2024-02-05T14:33:48.991Z (5 months ago)
• Topics: bun, svelte, typescript
• Language: JavaScript
• Homepage:
• Size: 48.8 KB
• Stars: 39
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Lists

• awesome-bun - sveltekit-bun-template

README

        
# Sveltekit + Bun

Everything you need to build a Svelte project, powered by [Bun](https://bun.sh) and the [`svelte-adapter-bun`](https://github.com/gornostay25/svelte-adapter-bun) package. Based on the [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte) skeleton project.

## Requirements

- Node.js LTS or newer

- Bun

## Clone & Setup

```bash

bun create TheOtterlord/sveltekit-bun-template my-project

```

## Developing

Once you've created a project and navigated to the root directory of the project, start a development server:

```bash

bun run dev

# or start the server and open the app in a new browser tab

bun run dev -- --open

```

## Building

To create a production version of your app:

```bash

bun run build

```

To skip type-checking when building for production, instead use:

```

bun run build:force

```

You can preview the production build with `bun run preview`.

In the production environment, you can use `bun ./build/index.js` to run the production server.

## Important notes

- Vite will not type-check on the development server. This is a known issue with Sveltekit and more information can be found [here](https://github.com/ivanhofer/sveltekit-typescript-showcase#type-checking-the-whole-project). Run `bun run check` or `bun run check:watch` if you need type-checking during development.

- The Bun runtime is not used for the development server or any build or check processes. Vite instead uses the Node.js runtime. Bun is only used to run the production server.