This repository has been archived by the owner on Dec 23, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 31
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
19 changed files
with
1,803 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
/node_modules/ | ||
/public/build/ | ||
|
||
.DS_Store |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
*Looking for a shareable component template? Go here --> [sveltejs/component-template](https://github.com/sveltejs/component-template)* | ||
|
||
--- | ||
|
||
# svelte app | ||
|
||
This is a project template for [Svelte](https://svelte.dev) apps. It lives at https://github.com/sveltejs/template. | ||
|
||
To create a new project based on this template using [degit](https://github.com/Rich-Harris/degit): | ||
|
||
```bash | ||
npx degit sveltejs/template svelte-app | ||
cd svelte-app | ||
``` | ||
|
||
*Note that you will need to have [Node.js](https://nodejs.org) installed.* | ||
|
||
|
||
## 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 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
{ | ||
"name": "svelte-app", | ||
"version": "1.0.0", | ||
"scripts": { | ||
"build": "rollup -c", | ||
"dev": "rollup -c -w", | ||
"start": "sirv public --single" | ||
}, | ||
"devDependencies": { | ||
"@rollup/plugin-commonjs": "^17.0.0", | ||
"@rollup/plugin-node-resolve": "^11.0.0", | ||
"rollup": "^2.3.4", | ||
"rollup-plugin-css-only": "^3.1.0", | ||
"rollup-plugin-livereload": "^2.0.0", | ||
"rollup-plugin-svelte": "^7.0.0", | ||
"rollup-plugin-terser": "^7.0.0", | ||
"svelte": "^3.0.0", | ||
"svelte-preprocess": "^4.6.9" | ||
}, | ||
"dependencies": { | ||
"autoprefixer": "^10.2.5", | ||
"page": "^1.11.6", | ||
"postcss": "^8.2.8", | ||
"sirv-cli": "^1.0.0", | ||
"tailwindcss": "^2.0.3" | ||
} | ||
} |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
html, body { | ||
position: relative; | ||
width: 100%; | ||
height: 100%; | ||
color: var(--color-text) | ||
} |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
<!DOCTYPE html> | ||
<html lang="en"> | ||
<head> | ||
<meta charset='utf-8'> | ||
<meta name='viewport' content='width=device-width,initial-scale=1'> | ||
|
||
<title>MailWhale WebUI</title> | ||
|
||
<link rel='icon' type='image/png' href='/favicon.png'> | ||
<link rel='stylesheet' href='/global.css'> | ||
<link rel='stylesheet' href='/build/bundle.css'> | ||
|
||
<script defer src='/build/bundle.js'></script> | ||
</head> | ||
|
||
<body class="flex flex-col"> | ||
</body> | ||
</html> |
Oops, something went wrong.