Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mrtkp9993/svelte-todo
Todo App with Svelte.
https://github.com/mrtkp9993/svelte-todo
beginner-friendly beginner-project javascript sirv svelte sveltejs todo todo-list todoapp todolist
Last synced: 19 days ago
JSON representation
Todo App with Svelte.
- Host: GitHub
- URL: https://github.com/mrtkp9993/svelte-todo
- Owner: mrtkp9993
- License: gpl-3.0
- Created: 2021-02-16T16:08:33.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-02-19T14:57:06.000Z (almost 4 years ago)
- Last Synced: 2024-05-02T03:37:32.083Z (9 months ago)
- Topics: beginner-friendly, beginner-project, javascript, sirv, svelte, sveltejs, todo, todo-list, todoapp, todolist
- Language: JavaScript
- Homepage: https://nostalgic-golick-967b13.netlify.app/
- Size: 51.8 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Todo 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: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).
## 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
```
## 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
```