feat(docs): update README.md
This commit is contained in:
51
README.md
51
README.md
@@ -1,38 +1,31 @@
|
|||||||
# sv
|
# Chief Beaver Officer land
|
||||||
|
|
||||||
Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli).
|
landing page for LifeOS - obsidian vault structure + AI agent prompt.
|
||||||
|
built with sveltekit, tailwind, mdsvex. deploys as static site.
|
||||||
|
|
||||||
## Creating a project
|
what it does:
|
||||||
|
- explains the LifeOS concept
|
||||||
|
- interactive obsidian component to explore vault structure
|
||||||
|
- prompt builder with raycast preset links
|
||||||
|
|
||||||
If you're seeing this, you've probably already done this step. Congrats!
|
stack:
|
||||||
|
- sveltekit + static adapter, tailwind css, webgl
|
||||||
|
|
||||||
```sh
|
run:
|
||||||
# create a new project in the current directory
|
```
|
||||||
npx sv create
|
bun i
|
||||||
|
bun dev
|
||||||
# create a new project in my-app
|
|
||||||
npx sv create my-app
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Developing
|
build:
|
||||||
|
```
|
||||||
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
|
bun run build
|
||||||
|
|
||||||
```sh
|
|
||||||
npm run dev
|
|
||||||
|
|
||||||
# or start the server and open the app in a new browser tab
|
|
||||||
npm run dev -- --open
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Building
|
creds:
|
||||||
|
- [raycast.com](https://raycast.com) (and my aww tysm) for design
|
||||||
|
- [liquid-glass-js](https://github.com/dashersw/liquid-glass-js) for header
|
||||||
|
- `claude --dangerously-skip-permissions` for implementation
|
||||||
|
- Chief Beaver Officer for its existence
|
||||||
|
|
||||||
To create a production version of your app:
|
✅ Certified neuroslop, built exactly in exactly 10 hours
|
||||||
|
|
||||||
```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.
|
|
||||||
|
|||||||
Reference in New Issue
Block a user