Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wolven531/svelte-temp
Repository to practice Svelte frontend development skills + GitHub Actions
https://github.com/wolven531/svelte-temp
gha github-actions githubactions jest jest-snapshots jest-tests surge surge-sh svelte sveltejs ts typescript
Last synced: 1 day ago
JSON representation
Repository to practice Svelte frontend development skills + GitHub Actions
- Host: GitHub
- URL: https://github.com/wolven531/svelte-temp
- Owner: Wolven531
- License: mit
- Created: 2022-02-07T07:20:16.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-07T06:35:04.000Z (over 1 year ago)
- Last Synced: 2024-04-09T06:33:15.593Z (7 months ago)
- Topics: gha, github-actions, githubactions, jest, jest-snapshots, jest-tests, surge, surge-sh, svelte, sveltejs, ts, typescript
- Language: JavaScript
- Homepage: https://svelte-temp.surge.sh
- Size: 538 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Svelte-temp
[![Build](https://github.com/Wolven531/svelte-temp/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/Wolven531/svelte-temp/actions/workflows/build.yml)
[![Unit Tests (jest)](https://github.com/Wolven531/svelte-temp/actions/workflows/unit-test.yml/badge.svg?branch=main)](https://github.com/Wolven531/svelte-temp/actions/workflows/unit-test.yml)
[![Deploy Website Using Surge](https://github.com/Wolven531/svelte-temp/actions/workflows/deploy-with-surge.yml/badge.svg?branch=main)](https://github.com/Wolven531/svelte-temp/actions/workflows/deploy-with-surge.yml)## Building and running in local mode
Install the dependencies
```bash
yarn
```Then, start in dev mode
```bash
yarn dev
```Finally, navigate to [localhost:8080](http://localhost:8080)
## Building and running in production mode
To create an optimized version of the app
```bash
yarn build
```Then, run the newly built app
```bash
yarn start
```### Notes
#### Using TypeScript
If you want to use `baseUrl` or `path` aliases within your `tsconfig`, you need to set up `@rollup/plugin-alias` to tell Rollup to resolve the aliases. For more info, see [this StackOverflow question](https://stackoverflow.com/questions/63427935/setup-tsconfig-path-in-svelte)
#### Single-page app mode
By default, sirv will only respond to requests that match files in `public`. This is to maximise compatibility w/ static fileservers, allowing you to deploy your app anywhere
If you're building a single-page app (SPA) w/ multiple routes, sirv needs to be able to respond to requests for _any_ path. You can make it so by editing the `"start"` command in package.json
```js
"start": "sirv public --single"
```#### Allow others to connect to hosted local app
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`
#### Running Production mode locally
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)
#### IDE Advice
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