aboutsummaryrefslogtreecommitdiff
path: root/web/pw-server/README.md
diff options
context:
space:
mode:
authorIlion Beyst <ilion.beyst@gmail.com>2021-12-30 14:15:40 +0100
committerIlion Beyst <ilion.beyst@gmail.com>2021-12-30 14:15:40 +0100
commit522f4270e83a85564ecc977aa470fcf8560547e2 (patch)
tree0dc688bde37aecd470a259bccc89f8bf3d24e710 /web/pw-server/README.md
parent3edf5d60f54bfd0cd2c818e5fb1ca133e324325d (diff)
downloadplanetwars.dev-522f4270e83a85564ecc977aa470fcf8560547e2.tar.xz
planetwars.dev-522f4270e83a85564ecc977aa470fcf8560547e2.zip
init SvelteKit frontend
Diffstat (limited to 'web/pw-server/README.md')
-rw-r--r--web/pw-server/README.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/web/pw-server/README.md b/web/pw-server/README.md
new file mode 100644
index 0000000..82510ca
--- /dev/null
+++ b/web/pw-server/README.md
@@ -0,0 +1,38 @@
+# create-svelte
+
+Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte);
+
+## 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
+npm init svelte@next
+
+# create a new project in my-app
+npm init svelte@next my-app
+```
+
+> Note: the `@next` is temporary
+
+## 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
+
+Before creating a production version of your app, install an [adapter](https://kit.svelte.dev/docs#adapters) for your target environment. Then:
+
+```bash
+npm run build
+```
+
+> You can preview the built app with `npm run preview`, regardless of whether you installed an adapter. This should _not_ be used to serve your app in production.