Skip to content

Commit

Permalink
docs(web): update README.md
Browse files Browse the repository at this point in the history
[no ci]
  • Loading branch information
MrExplode committed Nov 11, 2024
1 parent 940078c commit 5e5368b
Showing 1 changed file with 5 additions and 19 deletions.
24 changes: 5 additions & 19 deletions webapp/README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,24 @@
# sv
# web UI

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!

```bash
# create a new project in the current directory
npx sv create

# create a new project in my-app
npx sv create my-app
```

## Developing

Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
Once you've installed dependencies with `pnpm install`, start a development server:

```bash
npm run dev
pnpm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open
pnpm run dev -- --open
```

## Building

To create a production version of your app:

```bash
npm run build
pnpm run build
```

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

> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.

0 comments on commit 5e5368b

Please sign in to comment.