feat: polish
This commit is contained in:
parent
2e6177fe74
commit
4bd927bb4e
137 changed files with 6357 additions and 137560 deletions
54
README.md
54
README.md
|
|
@ -1,38 +1,40 @@
|
|||
# sv
|
||||
# leaflet_svelte
|
||||
|
||||
Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli).
|
||||
Weather-balloon trajectory planner. Static SvelteKit SPA that talks to a Django
|
||||
REST backend.
|
||||
|
||||
## Creating a project
|
||||
|
||||
If you're seeing this, you've probably already done this step. Congrats!
|
||||
## Quick start
|
||||
|
||||
```bash
|
||||
# create a new project in the current directory
|
||||
npx sv create
|
||||
npm install
|
||||
|
||||
# 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
|
||||
# dev against a local Django on :8000 (see .env.example)
|
||||
npm run dev
|
||||
|
||||
# or start the server and open the app in a new browser tab
|
||||
npm run dev -- --open
|
||||
```
|
||||
# dev with a fake backend (no Django needed)
|
||||
VITE_USE_MOCK_API=true npm run dev
|
||||
|
||||
## Building
|
||||
|
||||
To create a production version of your app:
|
||||
|
||||
```bash
|
||||
# type-check + production build (emits static files to ./build)
|
||||
npm run check
|
||||
npm run build
|
||||
```
|
||||
|
||||
You can preview the production build with `npm run preview`.
|
||||
Serve `build/` from any static host. Route fallback is `index.html`.
|
||||
|
||||
> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.
|
||||
## Documentation
|
||||
|
||||
- [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) — module layout and data flow.
|
||||
- [`docs/CONVENTIONS.md`](docs/CONVENTIONS.md) — naming, styling, component patterns.
|
||||
- [`docs/ADDING_A_FEATURE.md`](docs/ADDING_A_FEATURE.md) — walkthrough for adding
|
||||
a new panel/feature.
|
||||
- [`mocks/`](mocks/) — Vite dev-server mock backend.
|
||||
|
||||
## Stack
|
||||
|
||||
- **SvelteKit + Vite** (TypeScript, Svelte 5 runes) — built as a pure SPA with
|
||||
`@sveltejs/adapter-static`.
|
||||
- **MapLibre GL JS** via the `$map` abstraction — the app never imports
|
||||
`maplibre-gl` directly outside `src/lib/map/`.
|
||||
- **Sveltestrap** + Bootstrap 5 for UI chrome.
|
||||
- **Chart.js** for the ascent/descent profile editor.
|
||||
- **@vincjo/datatables** for editor tables.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue