https://github.com/snipcart/svelte-to-do-app
https://github.com/snipcart/svelte-to-do-app
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/snipcart/svelte-to-do-app
- Owner: snipcart
- Created: 2022-02-28T20:19:30.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-03-07T18:19:08.000Z (over 3 years ago)
- Last Synced: 2025-03-28T10:50:21.172Z (2 months ago)
- Language: JavaScript
- Homepage:
- Size: 54.7 KB
- Stars: 8
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Svelte.js Tutorial - The Framework to Write Faster JavaScript

This repo is part of a tutorial to build a simple to-do app with Svelte.js.>Read the tutorial [here](https://snipcart.com/blog/svelte-js-framework-tutorial)
>View the live demo [here](https://adoring-goldberg-83bffa.netlify.app/)
## Get started
Install the dependencies...
```bash
cd svelte-app
npm install
```...then start [Rollup](https://rollupjs.org):
```bash
npm run dev
```Navigate to [localhost:8080](http://localhost:8080). 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).
## Single-page app mode
By default, sirv will only respond to requests that match files in `public`. This is to maximise compatibility with static fileservers, allowing you to deploy your app anywhere.
If you're building a single-page app (SPA) with 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"
```## Using TypeScript
This template comes with a script to set up a TypeScript development environment, you can run it immediately after cloning the template with:
```bash
node scripts/setupTypeScript.js
```Or remove the script via:
```bash
rm scripts/setupTypeScript.js
```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).
## Deploying to the web
### With [Vercel](https://vercel.com)
Install `vercel` if you haven't already:
```bash
npm install -g vercel
```Then, from within your project folder:
```bash
cd public
vercel deploy --name my-project
```### With [surge](https://surge.sh/)
Install `surge` if you haven't already:
```bash
npm install -g surge
```Then, from within your project folder:
```bash
npm run build
surge public my-project.surge.sh
```