https://github.com/josecelano/svelte-deploy-with-github-actions

This is an example repository about how to automatically deploy Svelte apps to GitHub Pages using GitHub Actions
https://github.com/josecelano/svelte-deploy-with-github-actions

gh-actions gh-pages svelte

Last synced: 6 days ago
JSON representation

This is an example repository about how to automatically deploy Svelte apps to GitHub Pages using GitHub Actions

• Host: GitHub
• URL: https://github.com/josecelano/svelte-deploy-with-github-actions
• Owner: josecelano
• Created: 2021-09-10T09:19:23.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2021-09-10T12:10:54.000Z (about 3 years ago)
• Last Synced: 2023-04-14T05:27:21.180Z (over 1 year ago)
• Topics: gh-actions, gh-pages, svelte
• Language: Svelte
• Homepage:
• Size: 80.1 KB
• Stars: 11
• Watchers: 2
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![Deploy to GitHub Pages](https://github.com/josecelano/svelte-deploy-with-github-actions/actions/workflows/deploy.yml/badge.svg)](https://github.com/josecelano/svelte-deploy-with-github-actions/actions/workflows/deploy.yml)

This is a sample project to learn how to deploy [Svelte](https://svelte.dev) applications to [GitHub Pages](https://pages.github.com/) using [GitHub Actions](https://docs.github.com/en/actions).

You can see this live page here: https://josecelano.github.io/svelte-deploy-with-github-actions/

The page itself contains the explanations about how to deploy Svelte Apps to GitHub Pages using GitHub Actions.

## Get started

```

git clone [email protected]:josecelano/svelte-deploy-with-github-actions.git

```

Install the dependencies...

```bash

cd svelte-deploy-with-github-actions

npm install

```

...then start [Rollup](https://rollupjs.org):

```bash

npm run dev

```

Navigate to [localhost:5000](http://localhost:5000). You should see your app running. Edit a component file in `src`, save it, and reload the page to see your changes.

By default, the server will only respond to requests from localhost. To allow connections from other computers, edit the `sirv` commands in package.json to include the option `--host 0.0.0.0`.

If you're using [Visual Studio Code](https://code.visualstudio.com/) we recommend installing the official extension [Svelte for VS Code](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode). If you are using other editors you may need to install a plugin in order to get syntax highlighting and intellisense.

## Building and running in production mode

To create an optimised version of the app:

```bash

npm run build

```

You can run the newly built app with `npm run start`. This uses [sirv](https://github.com/lukeed/sirv), which is included in your package.json's `dependencies` so that the app will work when you deploy to platforms like [Heroku](https://heroku.com).

## Links

* [Document how to use with github pages with Svelte](https://github.com/sveltejs/v2.svelte.dev/issues/360)

* [Deploy a Sapper Web App Automatically to GitHub Pages using GitHub Actions](https://gavinr.com/svelte-sapper-github-pages-actions/)

* [How to deploy a Sapper PWA on GitHub Pages](https://dev.to/pixeline/how-to-deploy-a-sapper-pwa-on-github-pages-47lc)

* [NPM package to publish files to a gh-pages branch on GitHub (or any other branch anywhere else)](https://www.npmjs.com/package/gh-pages)