Update README.md
This commit is contained in:
parent
504c8ecd6e
commit
b251074253
1 changed files with 13 additions and 21 deletions
34
README.md
34
README.md
|
|
@ -1,38 +1,30 @@
|
||||||
# sv
|
# wip sveltekit site for anylists
|
||||||
|
|
||||||
Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli).
|
|
||||||
|
|
||||||
## Creating a project
|
|
||||||
|
|
||||||
If you're seeing this, you've probably already done this step. Congrats!
|
|
||||||
|
|
||||||
|
## Setup
|
||||||
```bash
|
```bash
|
||||||
# create a new project in the current directory
|
bun install # install dependencies
|
||||||
npx sv create
|
|
||||||
|
bun run types # generate types from: https://winry.woach.me/Julia/anylists
|
||||||
|
|
||||||
# create a new project in my-app
|
|
||||||
npx sv create my-app
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Developing
|
## Developing
|
||||||
|
|
||||||
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
|
start the development server
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm run dev
|
bun run dev
|
||||||
|
|
||||||
# or start the server and open the app in a new browser tab
|
|
||||||
npm run dev -- --open
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Building
|
## Building
|
||||||
|
|
||||||
To create a production version of your app:
|
build with ssg:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm run build
|
bun run build
|
||||||
```
|
```
|
||||||
|
|
||||||
You can preview the production build with `npm run preview`.
|
preview the static site with:
|
||||||
|
```bash
|
||||||
> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.
|
bun run preview
|
||||||
|
```
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue