SvelteKit Example
This project is a note-taking app template built with SvelteKit, TypeScript, and Tailwind CSS, designed to demonstrate integration with Juno for app development. It showcases authentication, data storage, and file storage using Juno's Satellite container.
You can scaffold it using the following command, or browse the source code:
npm create juno@latest -- --template sveltekit-example
Source: github.com/junobuild/create-juno/templates/sveltekit-example
Folder Structure
sveltekit-example/
├── static/ # Static assets
├── src/
│ ├── lib/ # SvelteKit components, stores, types, etc.
│ ├── routes/ # SvelteKit routes and layouts
│ ├── app.css # Tailwind CSS styles
│ └── app.html # SvelteKit HTML template
├── juno.config.ts # Juno Satellite configuration
├── package.json # Project dependencies and scripts
├── vite.config.ts # Vite build configuration
├── README.md # User-facing documentation
└── ... # Other config and build files
Key Features
- Juno Integration: Uses Juno's Satellite for authentication, Datastore, and Storage.
- Authentication: Login/logout flow.
- Notes Collection: Users can create, view, and delete notes (text, with optional file URL).
- Images Collection: Supports file storage for images.
- Responsive UI: Built with Tailwind CSS for modern styling.
- Banner: Warns if the Satellite is not configured for local development.
Main Components
- src/routes/+layout.svelte: Main layout, initializes Juno Satellite, wraps content in authentication.
- lib/components/: Contains UI and logic for authentication, notes table, modal, banner, etc.
- lib/types/note.ts: TypeScript interface for notes.
- lib/types/user.ts: TypeScript interface for user.
Data Structure
- Note (
src/lib/types/note.ts
):
export interface Note {
text: string;
url?: string;
}
How to Run
- Install dependencies:
npm install
- Start Juno local emulator:
important
Requires the Juno CLI to be available npm i -g @junobuild/cli
juno dev start
- Create a Satellite for local dev:
- Visit http://localhost:5866 and follow the instructions.
- Update
juno.config.ts
with your Satellite ID.
- Create required collections:
notes
in Datastore: http://localhost:5866/datastoreimages
in Storage: http://localhost:5866/storage
- Start the frontend dev server (in a separate terminal):
npm run start
Juno-Specific Configuration
- juno.config.ts: Defines Satellite IDs for development/production, build source, and predeploy steps.
Production Deployment
- Create a Satellite on the Juno Console for mainnet.
- Update
juno.config.ts
with the production Satellite ID. - Build and deploy:
npm run build
juno deploy
Notes
- The app is intended as a starting point for Juno-based projects.
- All logic is in TypeScript and SvelteKit components/stores.
- The app is fully client-side (Server Side Rendering is not supported yet) and interacts with Juno via the Satellite container.
Juno SDK Used
The following functions from @junobuild/core
are used in this example:
Function | Purpose/Description | Where Used (File/Component) | Juno Docs/Source Reference |
---|---|---|---|
initSatellite | Initialize Juno Satellite container | src/routes/+layout.svelte | Initialization |
authSubscribe | Subscribe to auth state changes | src/lib/components/Auth.svelte | Subscription |
signIn | Sign in user | src/lib/components/Login.svelte | Sign-in |
signOut | Sign out user | src/lib/components/Logout.svelte | Sign-out |
listDocs | List documents in a collection | src/lib/components/Table.svelte | List documents |
setDoc | Create or update a document | src/lib/components/Modal.svelte | Add a document |
deleteDoc | Delete a document | src/lib/components/Delete.svelte | Delete a document |
uploadFile | Upload a file to storage | src/lib/components/Modal.svelte | Upload asset |
deleteAsset | Delete a file from storage | src/lib/components/Delete.svelte | Delete asset |