Skip to content
This repository was archived by the owner on Jan 12, 2024. It is now read-only.

Commit 73c8793

Browse files
oliveriosousaoliveriosousa
committed
wip: example with svelte
1 parent 1e9f277 commit 73c8793

File tree

10 files changed

+477
-0
lines changed

10 files changed

+477
-0
lines changed

‎examples/browser-svelte/.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
/node_modules/
2+
/public/build/
3+
4+
.DS_Store

‎examples/browser-svelte/README.md

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
*Looking for a shareable component template? Go here --> [sveltejs/component-template](https://github.com/sveltejs/component-template)*
2+
3+
---
4+
5+
# svelte app
6+
7+
This is a project template for [Svelte](https://svelte.dev) apps. It lives at https://github.com/sveltejs/template.
8+
9+
To create a new project based on this template using [degit](https://github.com/Rich-Harris/degit):
10+
11+
```bash
12+
npx degit sveltejs/template svelte-app
13+
cd svelte-app
14+
```
15+
16+
*Note that you will need to have [Node.js](https://nodejs.org) installed.*
17+
18+
19+
## Get started
20+
21+
Install the dependencies...
22+
23+
```bash
24+
cd svelte-app
25+
npm install
26+
```
27+
28+
...then start [Rollup](https://rollupjs.org):
29+
30+
```bash
31+
npm run dev
32+
```
33+
34+
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.
35+
36+
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`.
37+
38+
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.
39+
40+
## Building and running in production mode
41+
42+
To create an optimised version of the app:
43+
44+
```bash
45+
npm run build
46+
```
47+
48+
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).
49+
50+
51+
## Single-page app mode
52+
53+
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.
54+
55+
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:
56+
57+
```js
58+
"start": "sirv public --single"
59+
```
60+
61+
## Using TypeScript
62+
63+
This template comes with a script to set up a TypeScript development environment, you can run it immediately after cloning the template with:
64+
65+
```bash
66+
node scripts/setupTypeScript.js
67+
```
68+
69+
Or remove the script via:
70+
71+
```bash
72+
rm scripts/setupTypeScript.js
73+
```
74+
75+
## Deploying to the web
76+
77+
### With [Vercel](https://vercel.com)
78+
79+
Install `vercel` if you haven't already:
80+
81+
```bash
82+
npm install -g vercel
83+
```
84+
85+
Then, from within your project folder:
86+
87+
```bash
88+
cd public
89+
vercel deploy --name my-project
90+
```
91+
92+
### With [surge](https://surge.sh/)
93+
94+
Install `surge` if you haven't already:
95+
96+
```bash
97+
npm install -g surge
98+
```
99+
100+
Then, from within your project folder:
101+
102+
```bash
103+
npm run build
104+
surge public my-project.surge.sh
105+
```

‎examples/browser-svelte/package.json

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{
2+
"name": "example-browser-svelte",
3+
"version": "1.0.0",
4+
"private": true,
5+
"scripts": {
6+
"build": "rollup -c",
7+
"dev": "rollup -c -w",
8+
"start": "sirv public --no-clear"
9+
},
10+
"devDependencies": {
11+
"@rollup/plugin-commonjs": "^17.0.0",
12+
"@rollup/plugin-json": "^4.1.0",
13+
"@rollup/plugin-node-resolve": "^11.0.0",
14+
"rollup": "^2.3.4",
15+
"rollup-plugin-css-only": "^3.1.0",
16+
"rollup-plugin-livereload": "^2.0.0",
17+
"rollup-plugin-polyfill-node": "^0.7.0",
18+
"rollup-plugin-svelte": "^7.0.0",
19+
"rollup-plugin-terser": "^7.0.0",
20+
"svelte": "^3.0.0"
21+
},
22+
"dependencies": {
23+
"ipfs": "^0.56.0",
24+
"sirv-cli": "^1.0.0"
25+
}
26+
}

‎examples/browser-svelte/public/favicon.png

3.05 KB
Loading

‎examples/browser-svelte/public/global.css

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
html, body {
2+
position: relative;
3+
width: 100%;
4+
height: 100%;
5+
}
6+
7+
body {
8+
color: #333;
9+
margin: 0;
10+
padding: 8px;
11+
box-sizing: border-box;
12+
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen-Sans, Ubuntu, Cantarell, "Helvetica Neue", sans-serif;
13+
}
14+
15+
a {
16+
color: rgb(0,100,200);
17+
text-decoration: none;
18+
}
19+
20+
a:hover {
21+
text-decoration: underline;
22+
}
23+
24+
a:visited {
25+
color: rgb(0,80,160);
26+
}
27+
28+
label {
29+
display: block;
30+
}
31+
32+
input, button, select, textarea {
33+
font-family: inherit;
34+
font-size: inherit;
35+
-webkit-padding: 0.4em 0;
36+
padding: 0.4em;
37+
margin: 0 0 0.5em 0;
38+
box-sizing: border-box;
39+
border: 1px solid #ccc;
40+
border-radius: 2px;
41+
}
42+
43+
input:disabled {
44+
color: #ccc;
45+
}
46+
47+
button {
48+
color: #333;
49+
background-color: #f4f4f4;
50+
outline: none;
51+
}
52+
53+
button:disabled {
54+
color: #999;
55+
}
56+
57+
button:not(:disabled):active {
58+
background-color: #ddd;
59+
}
60+
61+
button:focus {
62+
border-color: #666;
63+
}

‎examples/browser-svelte/public/index.html

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset='utf-8'>
5+
<meta name='viewport' content='width=device-width,initial-scale=1'>
6+
7+
<title>Svelte app</title>
8+
9+
<link rel='icon' type='image/png' href='/favicon.png'>
10+
<link rel='stylesheet' href='/global.css'>
11+
<link rel='stylesheet' href='/build/bundle.css'>
12+
13+
<script defer src='/build/bundle.js'></script>
14+
</head>
15+
16+
<body>
17+
</body>
18+
</html>

‎examples/browser-svelte/rollup.config.js

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
import svelte from 'rollup-plugin-svelte';
2+
import commonjs from '@rollup/plugin-commonjs';
3+
import json from '@rollup/plugin-json';
4+
import nodePolyfills from 'rollup-plugin-polyfill-node';
5+
import resolve from '@rollup/plugin-node-resolve';
6+
import livereload from 'rollup-plugin-livereload';
7+
import { terser } from 'rollup-plugin-terser';
8+
import css from 'rollup-plugin-css-only';
9+
10+
const production = !process.env.ROLLUP_WATCH;
11+
12+
function serve() {
13+
let server;
14+
15+
function toExit() {
16+
if (server) server.kill(0);
17+
}
18+
19+
return {
20+
writeBundle() {
21+
if (server) return;
22+
server = require('child_process').spawn('npm', ['run', 'start', '--', '--dev'], {
23+
stdio: ['ignore', 'inherit', 'inherit'],
24+
shell: true
25+
});
26+
27+
process.on('SIGTERM', toExit);
28+
process.on('exit', toExit);
29+
}
30+
};
31+
}
32+
33+
export default {
34+
input: 'src/main.js',
35+
output: {
36+
sourcemap: true,
37+
format: 'iife',
38+
name: 'app',
39+
file: 'public/build/bundle.js'
40+
},
41+
plugins: [
42+
svelte({
43+
compilerOptions: {
44+
// enable run-time checks when not in production
45+
dev: !production
46+
}
47+
}),
48+
// we'll extract any component CSS out into
49+
// a separate file - better for performance
50+
css({ output: 'bundle.css' }),
51+
52+
json(),
53+
54+
nodePolyfills( /* options */ ),
55+
56+
// If you have external dependencies installed from
57+
// npm, you'll most likely need these plugins. In
58+
// some cases you'll need additional configuration -
59+
// consult the documentation for details:
60+
// https://github.com/rollup/plugins/tree/master/packages/commonjs
61+
resolve({
62+
browser: true,
63+
dedupe: ['svelte']
64+
}),
65+
commonjs(),
66+
67+
// In dev mode, call `npm run start` once
68+
// the bundle has been generated
69+
!production && serve(),
70+
71+
// Watch the `public` directory and refresh the
72+
// browser on changes when not in production
73+
!production && livereload('public'),
74+
75+
// If we're building for production (npm run build
76+
// instead of npm run dev), minify
77+
production && terser()
78+
],
79+
watch: {
80+
clearScreen: false
81+
}
82+
};

0 commit comments

Comments
 (0)