Adding an MIT license and updating the README

This commit is contained in:
2025-12-08 11:19:55 -06:00
parent 117099bea4
commit 250cad6dab
2 changed files with 33 additions and 31 deletions

View File

@@ -1,38 +1,25 @@
# sv
# On The Spectrum - A party game to argue with friends about
Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli).
## Building project
## Creating a project
Preliminary steps:
If you're seeing this, you've probably already done this step. Congrats!
- Get [Bun](https://bun.com/docs/installation) `curl -fsSL https://bun.com/install | bash`
- Maybe need [Node](https://nodejs.org/en/download) too?
- IDK. I'm also using [Jujitsu](https://docs.jj-vcs.dev/latest/) but you don't have to.
- Ask me if you have questions
- You'll also prolly have to get ssh keys to push but idk.
```sh
# create a new project in the current directory
npx sv create
# git clone the directory
git clone git@git.sr.ht:~svlad_cjelli/onTheSpectrum
# create a new project in my-app
npx sv create my-app
# cd into directory
cd onTheSpectrum
# bun install all dependencies
bun i
# bun run with bun backend
bun --bun run dev --open
```
## Developing
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
```sh
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:
```sh
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.