Update README.md with project setup, development instructions, environment variables, and build process for Svelte 5 and SvelteKit integration.
This commit is contained in:
@@ -1,2 +1,56 @@
|
||||
# Daily-report
|
||||
|
||||
Svelte 5 + SvelteKit + shadcn-svelte + Tailwind v4, with Bun.
|
||||
|
||||
## Creating a project
|
||||
|
||||
If you're seeing this, you've probably already done this step. Congrats!
|
||||
|
||||
```sh
|
||||
# create a new project
|
||||
npx sv create my-app
|
||||
```
|
||||
|
||||
To recreate this project with the same configuration:
|
||||
|
||||
```sh
|
||||
# recreate this project
|
||||
bun x sv create --template minimal --types ts --install bun . --no-dir-check
|
||||
```
|
||||
|
||||
## Developing
|
||||
|
||||
Start the dev server (dependencies are installed with Bun):
|
||||
|
||||
```sh
|
||||
bun run dev
|
||||
# or open in browser
|
||||
bun run dev -- --open
|
||||
```
|
||||
|
||||
Add more shadcn-svelte components:
|
||||
|
||||
```sh
|
||||
bun x shadcn-svelte@latest add card
|
||||
bun x shadcn-svelte@latest add input
|
||||
# or list: bun x shadcn-svelte@latest add --help
|
||||
```
|
||||
|
||||
## Environment
|
||||
|
||||
Copy `.env.example` to `.env` and set:
|
||||
|
||||
- **FIREWORKS_API_KEY** (required) – Fireworks AI API key for generating the daily report.
|
||||
- **GITEA_TOKEN** (optional) – Gitea token if you need to access private repos or avoid rate limits.
|
||||
|
||||
## Building
|
||||
|
||||
To create a production version of your app:
|
||||
|
||||
```sh
|
||||
bun 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