summaryrefslogtreecommitdiffstats
path: root/apps/frontpage/README.md
diff options
context:
space:
mode:
authorivarlovlie <git@ivarlovlie.no>2022-06-05 15:43:08 +0200
committerivarlovlie <git@ivarlovlie.no>2022-06-05 15:43:33 +0200
commit1cb220ef54ddaf635b322d8c24f38613f371285e (patch)
tree8fa0445d9642b8774b7ecfeea5d45a244403d82d /apps/frontpage/README.md
parentdccb6a5cf79699ed78bc3101f76c97b21f5a842e (diff)
downloadgreatoffice-1cb220ef54ddaf635b322d8c24f38613f371285e.tar.xz
greatoffice-1cb220ef54ddaf635b322d8c24f38613f371285e.zip
feat: New frontpage
Diffstat (limited to 'apps/frontpage/README.md')
-rw-r--r--apps/frontpage/README.md39
1 files changed, 37 insertions, 2 deletions
diff --git a/apps/frontpage/README.md b/apps/frontpage/README.md
index 42ee3ec..374efec 100644
--- a/apps/frontpage/README.md
+++ b/apps/frontpage/README.md
@@ -1,3 +1,38 @@
-# Frontpage
+# create-svelte
-This is a sveltekit app that makes up the frontpage on greatoffice.life
+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
+
+# create a new project in my-app
+npm init svelte 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://kit.svelte.dev/docs/adapters) for your target environment.