Boilerplate svelte app

This commit is contained in:
Brian Ginsburg 2022-07-14 11:41:33 -07:00
parent ca08b5cfea
commit 2b98bce42b
No known key found for this signature in database
GPG Key ID: B7A01B90EB115B2D
27 changed files with 13074 additions and 101 deletions

BIN
.DS_Store vendored Normal file

Binary file not shown.

6
.eslintignore Normal file
View File

@ -0,0 +1,6 @@
.eslintrc.cjs
svelte.config.js
tsnode-loader.js
src/hooks.ts
src/lib/controllers/keyboard.ts
static/webaudio-controls.js

46
.eslintrc.cjs Normal file
View File

@ -0,0 +1,46 @@
module.exports = {
parser: '@typescript-eslint/parser',
parserOptions: {
ecmaVersion: 2020,
sourceType: 'module',
tsconfigRootDir: __dirname,
project: ['./tsconfig.json'],
extraFileExtensions: ['.svelte']
},
env: {
es6: true,
browser: true
},
settings: {
'svelte3/typescript': () => require('typescript'),
},
plugins: ['svelte3', '@typescript-eslint'],
ignorePatterns: ['node_modules'],
extends: [
'eslint:recommended',
'plugin:@typescript-eslint/recommended',
'plugin:@typescript-eslint/recommended-requiring-type-checking'
],
overrides: [
{
files: ['*.svelte'],
processor: 'svelte3/svelte3'
}
],
rules: {
"@typescript-eslint/ban-ts-comment": ['error', { 'ts-ignore': 'allow-with-description'}],
'@typescript-eslint/member-delimiter-style': ['error', {
'multiline': {
'delimiter': 'none',
'requireLast': false
}
}],
'@typescript-eslint/no-use-before-define': ['off'],
'@typescript-eslint/semi': ['error', 'never'],
'@typescript-eslint/quotes': ['error', 'single', {
allowTemplateLiterals: true
}],
// If you want to *intentionally* run a promise without awaiting, prepend it with "void " instead of "await "
'@typescript-eslint/no-floating-promises': ['error']
}
}

26
.github/workflows/publish.yml vendored Normal file
View File

@ -0,0 +1,26 @@
name: 🚀 Publish
on:
push:
branches:
- main
jobs:
publish_job:
name: "🚀 Publish"
runs-on: ubuntu-latest
steps:
- name: 📥 Checkout repository
uses: actions/checkout@v2
- name: 🧱 Setup node
uses: actions/setup-node@v2
with:
node-version: "16"
- name: 📦 Install packages
run: npm install
- name: 🏗 Build assets
run: npm run build
- name: 🚀 Publish to production
uses: fission-suite/publish-action@v1
with:
machine_key: ${{ secrets.FISSION_MACHINE_KEY }}
app_url: svelte-elementary-template.fission.app
build_dir: ./build

107
.gitignore vendored
View File

@ -1,104 +1,9 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
# Runtime data
pids
*.pid
*.seed
*.pid.lock
# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov
# Coverage directory used by tools like istanbul
coverage
*.lcov
# nyc test coverage
.nyc_output
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt
# Bower dependency directory (https://bower.io/)
bower_components
# node-waf configuration
.lock-wscript
# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release
# Dependency directories
# node
node_modules/
jspm_packages/
# TypeScript v1 declaration files
typings/
# svelte
.svelte-kit/
build/
# TypeScript cache
*.tsbuildinfo
# Optional npm cache directory
.npm
# Optional eslint cache
.eslintcache
# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/
# Optional REPL history
.node_repl_history
# Output of 'npm pack'
*.tgz
# Yarn Integrity file
.yarn-integrity
# dotenv environment variables file
.env
.env.test
# parcel-bundler cache (https://parceljs.org/)
.cache
# Next.js build output
.next
# Nuxt.js build / generate output
.nuxt
dist
# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and *not* Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public
# vuepress build output
.vuepress/dist
# Serverless directories
.serverless/
# FuseBox cache
.fusebox/
# DynamoDB Local files
.dynamodb/
# TernJS port file
.tern-port
# macOS
.DS_Store5

12
.prettierrc.cjs Normal file
View File

@ -0,0 +1,12 @@
module.exports = {
arrowParens: 'avoid',
plugins: ['prettier-plugin-svelte'],
semi: false,
singleQuote: true,
svelteBracketNewLine: true,
svelteSortOrder: 'options-scripts-markup-styles',
svelteStrictMode: false,
svelteIndentScriptAndStyle: true,
tabWidth: 2,
trailingComma: 'none'
}

208
NOTICE Normal file
View File

@ -0,0 +1,208 @@
TODO: Remove once `static/preview.png` is removed.
** Social preview image by Pawel Czerwinski **
Use under Unsplash license. Recovered from https://unsplash.com/photos/eybM9n4yrpE on June 11th, 2022.
** Project boilerplate and shaved yaks from the UCAN working group's UCAN web site and validator **
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright 2021 Fission Internet Software
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

View File

@ -1,2 +1,53 @@
# webnative-app-template
A web app template for Webnative
## Setup
Install dependencies.
```shell
npm install
```
## Develop
Work on the application in local development.
```shell
npm run dev
```
Navigate to `localhost:3000` in your web browser.
## Build
Export a static build.
```shell
npm run build
```
The build outputs the static site to the `build` directory.
## Publish
The built site publishes with the [Fission CLI](https://guide.fission.codes/developers/cli) and the [Fission GH publish action](https://github.com/fission-suite/publish-action). Publishing from the command line is configured in [fission.yaml](fission.yaml), and the GitHub publish action is configured in [publish.yml](.github/workflows/publish.yml).
To configure your own CLI publishing:
1. [Install the Fission CLI](https://guide.fission.codes/developers/installation)
2. Run `fission setup` to make a Fission account
3. Run `npm run build` to build the app
4. Delete `fission.yaml`
5. Run `fission app register` to register a new Fission app (accept the `./build` directory suggestion for your build directory)
6. Run `fission app publish` to publish your app to the web
After publishing, your app will be available online at the domain assigned by the register command.
To set up the GitHub publish action:
1. Export your machine key with `base64 ~/.config/fission/key/machine_id.ed25519`
2. Add your machine key as a GH Repository secret named `FISSION_MACHINE_KEY`
2. Update the `publish.yml` with the name of your registered app
See the [Fission Guide](https://guide.fission.codes/developers/installation) and the publish action README for more details.

8599
package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

55
package.json Normal file
View File

@ -0,0 +1,55 @@
{
"name": "svelte-elemetary-template",
"version": "0.1.0",
"scripts": {
"dev": "vite dev",
"build": "vite build",
"preview": "vite preview",
"test": "ava src/**/*.test.ts",
"check": "svelte-check --tsconfig ./tsconfig.json",
"check:watch": "svelte-check --tsconfig ./tsconfig.json --watch",
"lint": "eslint './src/**/*.{js,ts,svelte}'",
"format": "prettier --write --plugin-search-dir=. ."
},
"devDependencies": {
"@sveltejs/adapter-static": "next",
"@sveltejs/kit": "next",
"@tailwindcss/typography": "^0.5.2",
"@typescript-eslint/eslint-plugin": "^4.33.0",
"@typescript-eslint/parser": "^4.33.0",
"ava": "^3.15.0",
"daisyui": "^2.0.2",
"eslint": "^7.32.0",
"eslint-config-prettier": "^8.1.0",
"eslint-plugin-svelte3": "^3.2.1",
"one-webcrypto": "^1.0.1",
"prettier": "~2.2.1",
"prettier-plugin-svelte": "^2.2.0",
"svelte": "^3.34.0",
"svelte-check": "^2.0.0",
"svelte-preprocess": "^4.0.0",
"svelte-seo": "^1.2.1",
"tailwindcss": "^3.0.22",
"ts-node": "^10.4.0",
"tsconfig-paths": "^3.12.0",
"tslib": "^2.0.0",
"typescript": "^4.4.4",
"vite": "^3.0.0"
},
"type": "module",
"ava": {
"extensions": {
"ts": "module"
},
"require": [
"ts-node/register",
"tsconfig-paths/register"
],
"nonSemVerExperiments": {
"configurableModuleFormat": true
},
"nodeArguments": [
"--loader=./tsnode-loader.js"
]
}
}

5
postcss.config.cjs Normal file
View File

@ -0,0 +1,5 @@
module.exports = {
plugins: {
tailwindcss: {},
},
};

33
src/app.html Normal file
View File

@ -0,0 +1,33 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>WebNative Template</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="robots" content="index,follow">
<meta name="googlebot" content="index,follow">
<meta name="description" content="TODO">
<meta property="og:title" content="WebNative Template">
<meta property="og:description" content="A template for WebNative applications">
<meta property="og:url" content="TODO">
<meta property="og:type" content="website">
<meta property="og:image" content="TODO">
<meta property="og:image:alt" content="WebNative Template">
<meta property="og:image:width" content="1200">
<meta property="og:image:height" content="630">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:title" content="WebNative Template">
<meta name="twitter:description" content="A template for WebNative applications">
<meta name="twitter:image" content="TODO">
<meta name="twitter:image:alt" content="WebNative Template">
<link rel="icon" type="image/svg+xml" href="/favicon.svg" sizes="any">
%sveltekit.head%
</head>
<body>
<div id="svelte">%sveltekit.body%</div>
</body>
</html>

3
src/global.css Normal file
View File

@ -0,0 +1,3 @@
@tailwind base;
@tailwind components;
@tailwind utilities;

1
src/global.d.ts vendored Normal file
View File

@ -0,0 +1 @@
/// <reference types="@sveltejs/kit" />

8
src/hooks.ts Normal file
View File

@ -0,0 +1,8 @@
/** @type {import('@sveltejs/kit').Handle} */
export async function handle({ event, resolve }) {
const response = await resolve(event, {
ssr: false
});
return response;
}

16
src/lib/theme/index.ts Normal file
View File

@ -0,0 +1,16 @@
import { browser } from '$app/env'
export type Theme = 'light' | 'dark'
export const loadTheme = (): Theme => {
if (browser) {
return localStorage.getItem('theme') as Theme ?? 'dark'
}
}
export const storeTheme = (theme: Theme): void => {
if (browser) {
localStorage.setItem('theme', theme)
}
}

10
src/lib/theme/t.test.ts Normal file
View File

@ -0,0 +1,10 @@
import type { TestInterface } from 'ava'
import anyTest from 'ava'
const test = anyTest as TestInterface<{ thing: string }>
test('validates a ucan', t => {
t.is(true, true)
})

View File

@ -0,0 +1,15 @@
<script lang="ts">
import '../global.css'
import { theme } from '../stores'
import { storeTheme } from '$lib/theme'
theme.subscribe(val => {
storeTheme(val)
})
</script>
<div data-theme={$theme}>
<slot />
</div>

8
src/routes/index.svelte Normal file
View File

@ -0,0 +1,8 @@
<script lang="ts">
</script>
<h1>Hello world!</h1>
<style>
</style>

6
src/stores.ts Normal file
View File

@ -0,0 +1,6 @@
import { writable } from 'svelte/store'
import type { Writable } from 'svelte/store'
import { loadTheme } from '$lib/theme'
import type { Theme } from '$lib/theme'
export const theme: Writable<Theme> = writable(loadTheme())

3826
static/favicon.svg Normal file

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 1.9 MiB

BIN
static/preview.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 560 KiB

20
svelte.config.js Normal file
View File

@ -0,0 +1,20 @@
import preprocess from 'svelte-preprocess'
import adapter from '@sveltejs/adapter-static'
/** @type {import('@sveltejs/kit').Config} */
const config = {
// Consult https://github.com/sveltejs/svelte-preprocess
// for more information about preprocessors
preprocess: preprocess({
postcss: true,
}),
kit: {
adapter: adapter({
pages: 'build',
assets: 'build',
fallback: null
}),
}
}
export default config

41
tailwind.config.cjs Normal file
View File

@ -0,0 +1,41 @@
module.exports = {
mode: "jit",
content: ["./src/**/*.{html,js,svelte,ts}"],
plugins: [require("daisyui")],
daisyui: {
styled: true,
themes: [
{
dark: {
primary: "#43919b",
secondary: "#30aadd",
accent: "#00ffc6",
neutral: "#282828",
"base-content": "#ffffff",
"base-100": "#111111",
"--rounded-box": "2px",
"--rounded-btn": "2px",
"--rounded-badge": "2px",
"--tab-radius": "2px"
},
light : {
primary: "#43919b",
secondary: "#30aadd",
accent: "#00ffc6",
neutral: "#e5e5e5",
"base-content": "#000000",
"base-100": "#ffffff",
"--rounded-box": "2px",
"--rounded-btn": "2px",
"--rounded-badge": "2px",
"--tab-radius": "2px"
},
},
],
base: true,
utils: true,
logs: true,
rtl: false,
darkTheme: "dark",
},
};

32
tsconfig.json Normal file
View File

@ -0,0 +1,32 @@
{
"compilerOptions": {
"moduleResolution": "node",
"module": "es2020",
"lib": ["es2020"],
"target": "es2019",
/**
svelte-preprocess cannot figure out whether you have a value or a type, so tell TypeScript
to enforce using \`import type\` instead of \`import\` for Types.
*/
"importsNotUsedAsValues": "error",
"isolatedModules": true,
"resolveJsonModule": true,
/**
To have warnings/errors of the Svelte compiler at the correct position,
enable source maps by default.
*/
"sourceMap": true,
"esModuleInterop": true,
"skipLibCheck": true,
"forceConsistentCasingInFileNames": true,
"baseUrl": ".",
"allowJs": true,
"checkJs": true,
"paths": {
"$components/*": ["src/components/*"],
"$lib/*": ["src/lib/*"],
"$static/*": ["static/*"],
}
},
"include": ["src/**/*.d.ts", "src/**/*.js", "src/**/*.ts", "src/**/*.svelte"]
}

26
tsnode-loader.js Normal file
View File

@ -0,0 +1,26 @@
/** Load ESM modules with path mappings
* ts-node/esm does not currently support path mappings. This custom
* loader takes care of that. Tracking discussion and loader source code
* from https://github.com/TypeStrong/ts-node/discussions/1450
*/
import {
resolve as resolveTs,
getFormat,
load,
transformSource,
} from "ts-node/esm";
import * as tsConfigPaths from "tsconfig-paths"
export { getFormat, load, transformSource };
const { absoluteBaseUrl, paths } = tsConfigPaths.loadConfig()
const matchPath = tsConfigPaths.createMatchPath(absoluteBaseUrl, paths)
export function resolve(specifier, context, defaultResolver) {
const mappedSpecifier = matchPath(specifier)
if (mappedSpecifier) {
specifier = `${mappedSpecifier}.js`
}
return resolveTs(specifier, context, defaultResolver);
}

15
vite.config.ts Normal file
View File

@ -0,0 +1,15 @@
import { sveltekit } from '@sveltejs/kit/vite'
import { resolve } from 'path'
/** @type {import('vite').UserConfig} */
const config = {
plugins: [sveltekit()],
resolve: {
alias: {
$components: resolve('./src/components'),
$static: resolve('./static')
}
},
}
export default config