add preliminary README

This commit is contained in:
Markus Brueckner 2024-12-15 09:17:06 +01:00
parent 2050c715dc
commit 4e32589ce6

View file

@ -1,38 +1,7 @@
# sv # Three60
Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli). A very, very simple 360° review tool. Supports self-registration of users and limiting the registration to certain email address domains.
## Creating a project ## Caution
If you're seeing this, you've probably already done this step. Congrats! This is just a toy for me to experiment with SvelteKit and a few other libraries. This is nowhere near production-ready!
```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.