summaryrefslogtreecommitdiff
path: root/client/README.md
diff options
context:
space:
mode:
authorJoel Klinghed <the_jk@spawned.biz>2025-06-24 08:53:58 +0200
committerJoel Klinghed <the_jk@spawned.biz>2025-06-24 09:13:08 +0200
commitbdba7f5c449c0ac77bbd2420c5bc086a7e369a91 (patch)
tree0f4acd13a6a1c62f4e0b1b79a537b09c0470af2e /client/README.md
parentd104bd0671181376f0756ba8ae6a03880654c186 (diff)
Initial commit of client
Using svelte
Diffstat (limited to 'client/README.md')
-rw-r--r--client/README.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/client/README.md b/client/README.md
new file mode 100644
index 0000000..b5b2950
--- /dev/null
+++ b/client/README.md
@@ -0,0 +1,38 @@
+# sv
+
+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:
+
+```bash
+npm run dev
+
+# or start the server and open the app in a new browser tab
+npm run dev -- --open
+```
+
+## Building
+
+To create a production version of your app:
+
+```bash
+npm 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.