Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/halfdanj/svelte-adapter-appengine
Utilize the Google Cloud App Engine infrastructure to host SvelteKit content.
https://github.com/halfdanj/svelte-adapter-appengine
appengine google svelte svelte-adapter sveltekit
Last synced: 4 days ago
JSON representation
Utilize the Google Cloud App Engine infrastructure to host SvelteKit content.
- Host: GitHub
- URL: https://github.com/halfdanj/svelte-adapter-appengine
- Owner: HalfdanJ
- License: apache-2.0
- Created: 2021-10-20T04:07:04.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-30T18:23:57.000Z (2 months ago)
- Last Synced: 2024-10-14T15:19:12.816Z (23 days ago)
- Topics: appengine, google, svelte, svelte-adapter, sveltekit
- Language: JavaScript
- Homepage:
- Size: 2.16 MB
- Stars: 64
- Watchers: 8
- Forks: 11
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
# svelte-adapter-appengine
Easily deploy your SvelteKit applications on [Google Cloud App Engine](https://cloud.google.com/appengine) with the `svelte-adapter-appengine` package.
[](https://www.npmjs.com/package/svelte-adapter-appengine)
[](https://github.com/halfdanj/svelte-adapter-appengine/actions/workflows/test.yml)
[](https://kit.svelte.dev/)
## Getting Started
To set up the adapter in your SvelteKit project:
1. Install the package as a development dependency:
```bash
npm install --save-dev svelte-adapter-appengine
```
2. Update your `svelte.config.js` to use the adapter:
```diff
import { vitePreprocess } from '@sveltejs/vite-plugin-svelte';
+import adapter from "svelte-adapter-appengine";
/** @type {import('@sveltejs/kit').Config} */
const config = {
preprocess: vitePreprocess(),
kit: {
+ adapter: adapter(),
},
};
export default config;
```
3. Build your application:
```bash
npm run build
```
4. Deploy your application to App Engine:
```bash
gcloud app deploy --project build/app.yaml
```
Learn more about the `gcloud` utility in the [official documentation](https://cloud.google.com/sdk/gcloud)
## Configuration Options
Customize the adapter behavior using the following options:
```ts
adapter({
// Build output directory (default: `/build`)
out: "/build",
// Enable Google Cloud Tracing Agent for improved logging (default: `false`)
useCloudTracing: false,
// Enable or disable Google Cloud Logging (default: `false`)
// See: https://cloud.google.com/logging/docs/overview
useCloudLogging: false,
// Specify external modules for the esbuild step
external: [],
// Specify Node modules to be added to the `package.json` file in the build step
// These modules will be fetched when the application is deployed
dependencies: [],
// Set the Node.js version for the App Engine runtime (default: `18`)
// See available runtimes: https://cloud.google.com/appengine/docs/standard/nodejs/runtime
nodejsRuntime: 18,
});
```
You can also customize the generated `app.yaml` file by creating an `app.yaml` file in your project root. The adapter will merge your custom configuration with the generated `app.yaml`, allowing you to define custom machine types, routes, or other [app.yaml configurations](https://cloud.google.com/appengine/docs/standard/reference/app-yaml?tab=node.js).
## Adapter Output
The Server-Side Rendering (SSR) part of SvelteKit is hosted on App Engine using a Node.js runtime, using [polka](https://github.com/lukeed/polka) to mimic [@sveltejs/adapter-node
](https://github.com/sveltejs/kit/tree/master/packages/adapter-node).
Static files are served directly from Cloud Storage, bypassing the Node.js web server. The adapter automatically generates routes for all static assets in the `app.yaml` file.
## Example Application
Check out a live example application at [https://svelte-adapter-demo.uc.r.appspot.com/](https://svelte-adapter-demo.uc.r.appspot.com/). This demo app is the default SvelteKit template deployed with the default adapter settings.