# Project structure

An Expo Svelte project is a [SvelteKit project](https://svelte.dev/docs/kit/project-structure) with a native app added. After `expo-svelte init` it looks like this:

```tree
my-app/
├ src/
│ ├ lib/
│ │ ├ theme.ts
│ │ └ [your lib files]
│ ├ routes/
│ │ ├ +layout.svelte
│ │ ├ +page.svelte
│ │ ├ +layout.mobile.svelte
│ │ ├ +mobile.svelte
│ │ └ [your routes]
│ ├ app.d.ts
│ ├ app.html
│ └ hooks.mobile.ts
├ static/
├ patches/
│ └ expo-svelte/
├ .expo-svelte/
├ android/
├ ios/
├ app.json
├ metro.config.cjs
├ package.json
├ pnpm-workspace.yaml
├ tsconfig.json
└ vite.config.ts
```

Everything SvelteKit's page says still holds. This page covers what the native app adds.

## Project files

### src/routes

Web and native routes share the directory. SvelteKit reads the `+page` and `+layout` files, and Expo Svelte reads the `.mobile.svelte` ones:

- `+mobile.svelte` is a screen of the native app, the counterpart of `+page.svelte`.
- `+layout.mobile.svelte` is a native layout, the counterpart of `+layout.svelte`. The one at the root is the app shell.

[Routing](routing.md) explains them.

### src/lib

Shared code, as in any SvelteKit project. A `.ts` or `.svelte.ts` module that doesn't use the DOM works in the web app and on the phone. Components don't carry over: a web component renders `div`s, a native one renders [`View`](view.md)s.

`init` adds `src/lib/theme.ts`, the light and dark colours of the first screens ([Light and dark mode](styling.md#light-and-dark-mode)). If you already have a `theme.ts`, it writes `native-theme.ts` instead.

### src/hooks.mobile.ts

The native app's counterpart of `hooks.client.ts`, and optional: code that runs when the app starts, before any screen, and the hooks remote functions use. [Hooks](hooks.md) explains it.

### app.json

The configuration of the native app: its name, the identifiers that name it on a device (`android.package`, `ios.bundleIdentifier`), its icon, permissions, and the config plugins that change the native projects. Expo Svelte's plugin is in `plugins`. An `app.config.ts` works in its place if you'd rather compute it.

### metro.config.cjs

[Metro](https://metrobundler.dev) bundles the native app, as Vite bundles the web one. `withExpoSvelte` teaches it to compile `.svelte` files and find your routes.

### vite.config.ts

SvelteKit's plugin, wrapped by `expoSvelte()`. For `vite dev` and `vite build` it is the SvelteKit plugin you know, and it keeps the `.mobile.svelte` files out of the web build.

### package.json

`init` adds the packages the native app needs at exact versions, sets `"main"` to the generated entry point, and adds four scripts:

| Script | Runs | What it does |
| --- | --- | --- |
| `pnpm android` | `expo-svelte android` | build, install and open the app on Android |
| `pnpm ios` | `expo-svelte ios` | the same on iOS |
| `pnpm native` | `expo-svelte dev` | start the development server for an app that is already installed |
| `pnpm check-setup` | `expo-svelte doctor` | check the project's setup |

`dev`, `build`, `preview` and `check` stay the web app's.

### pnpm-workspace.yaml and patches

Expo Svelte needs small changes to a few packages it depends on, such as SvelteKit (so that it ignores `.mobile.svelte` files) and `expo-modules-core`. They ship as pnpm patches. (Reanimated, worklets and gesture handler need changes too, and the library carries its own patched copies of them: there is nothing to declare for those.) pnpm applies a patch only from your own project, so `init` copies the patch files into `patches/expo-svelte/` and lists them in `pnpm-workspace.yaml`. Run `init` again after you upgrade Expo Svelte, so the copies stay current. [Configuration](configuration.md#patches) lists them.

## Generated files

These are build output. Git ignores them, you can delete them at any time, and the tools write them again.

### .expo-svelte

The generated entry point, route table and hooks module of the native app, the counterpart of SvelteKit's `.svelte-kit`.

### android and ios

The native projects, generated from `app.json`, the config plugins and your packages by `expo prebuild`. Don't edit them: change the configuration and generate them again. [Development builds](development-builds.md) explains when. They don't exist until your first `pnpm android` or `pnpm ios`.

### .expo

Expo's cache.
