init

.gitattributes

@@ -0,0 +1,2 @@
+# helps with line endings for Windows in automated tests
+* text=auto eol=lf

.github/workflows/build-for-gh-pages.yml

@@ -0,0 +1,24 @@
+name: build-for-gh-pages
+
+on:
+    push:
+        branches:
+            - dev
+
+jobs:
+    build-for-gh-pages:
+        runs-on: 'ubuntu-latest'
+
+        steps:
+            - uses: actions/checkout@v3
+            - uses: actions/setup-node@v3
+              with:
+                  node-version-file: '.nvmrc'
+            - name: build
+              run: |
+                  npm ci
+                  npm run docs
+            - uses: JamesIves/github-pages-deploy-action@v4
+              with:
+                  branch: 'gh-pages'
+                  folder: 'dist'

.github/workflows/tests.yml

@@ -0,0 +1,25 @@
+name: tests
+
+on:
+    push:
+        branches:
+            - '**'
+
+jobs:
+    build:
+        runs-on: ${{ matrix.os }}
+        strategy:
+            fail-fast: false
+            matrix:
+                os: [ubuntu-latest, windows-latest, macos-latest]
+        steps:
+            - uses: actions/checkout@v3
+            - name: Use Node.js ${{ matrix.node-version }}
+              uses: actions/setup-node@v3
+              with:
+                  node-version-file: '.nvmrc'
+            - name: run test
+              run: |
+                  npm ci
+                  npx playwright install --with-deps
+                  npm run test:all

.gitignore

@@ -0,0 +1,13 @@
+*.tgz
+.DS_Store
+.not-committed/
+/Icon?
+coverage/
+dist-*/
+dist/
+generated-config-*
+graphics/
+node_modules/
+src/all-files-for-code-coverage.test.ts
+ts.out
+tsconfig.tsbuildinfo

.npmignore

@@ -0,0 +1,25 @@
+**/*/readme-examples/
+**/*/test/
+*.book-helper.*
+*.book.*
+*.d.ts.map
+*.test-helper.*
+*.test.*
+*.tgz
+.*
+.not-committed/
+/Icon?
+/configs/
+/coverage/
+/cspell.config.cjs
+/graphics/
+/src/
+/www-static/
+bash-scripts/
+dist-docs/
+generated-config-*
+index.html
+test-files/
+ts.out/
+tsconfig*.json
+tsconfig.tsbuildinfo

.nvmrc

@@ -0,0 +1 @@
+20

.prettierignore

@@ -0,0 +1,11 @@
+**/all-files-for-code-coverage.test.ts
+**/coverage/
+**/dist-*/
+**/dist/
+**/generated-config-*
+**/graphics/
+**/node_modules/
+**/package-lock.json
+**/ts.out/
+**/tsconfig.tsbuildinfo
+/Icon?

.prettierrc.js

@@ -0,0 +1,13 @@
+const {basePrettierConfig} = require('virmator/base-configs/base-prettierrc.js');
+
+/**
+ * @typedef {import('prettier-plugin-multiline-arrays').MultilineArrayOptions} MultilineOptions
+ *
+ * @typedef {import('prettier').Options} PrettierOptions
+ * @type {PrettierOptions & MultilineOptions}
+ */
+const prettierConfig = {
+    ...basePrettierConfig,
+};
+
+module.exports = prettierConfig;

.vscode/settings.json

@@ -0,0 +1,50 @@
+{
+    "[css]": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode"
+    },
+    "[html]": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode"
+    },
+    "[javascript]": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode"
+    },
+    "[javascriptreact]": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode"
+    },
+    "[json]": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode"
+    },
+    "[jsonc]": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode"
+    },
+    "[less]": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode"
+    },
+    "[markdown]": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode"
+    },
+    "[ruby]": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode"
+    },
+    "[scss]": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode"
+    },
+    "[toml]": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode"
+    },
+    "[typescript]": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode"
+    },
+    "[yaml]": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode"
+    },
+    "editor.formatOnSave": true,
+    "editor.rulers": [
+        100
+    ],
+    "editor.wordWrapColumn": 100,
+    "files.associations": {
+        "*.svg": "html"
+    },
+    "typescript.tsdk": "node_modules/typescript/lib"
+}

LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Toniq Labs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,3 @@
+# farcaster-frame-demo
+
+Demo of using https://docs.farcaster.xyz/learn/what-is-farcaster/frames

configs/dep-cruiser.config.ts

@@ -0,0 +1,22 @@
+import type {IConfiguration} from 'dependency-cruiser';
+import {generateDepCruiserConfig} from 'virmator/dist/compiled-base-configs/base-dep-cruiser.config';
+
+const baseConfig = generateDepCruiserConfig({
+    fileExceptions: {
+        // enter file exceptions by rule name here
+        'no-orphans': {
+            from: [
+                'src/index.ts',
+            ],
+        },
+    },
+    omitRules: [
+        // enter rule names here to omit
+    ],
+});
+
+const depCruiserConfig: IConfiguration = {
+    ...baseConfig,
+};
+
+module.exports = depCruiserConfig;

configs/ncu.config.ts

@@ -0,0 +1,12 @@
+import {RunOptions} from 'npm-check-updates';
+import {baseNcuConfig} from 'virmator/dist/compiled-base-configs/base-ncu';
+
+export const ncuConfig: RunOptions = {
+    ...baseNcuConfig,
+    // exclude these
+    reject: [
+        ...baseNcuConfig.reject,
+    ],
+    // include only these
+    filter: [],
+};

configs/typedoc.config.ts

@@ -0,0 +1,15 @@
+import {join, resolve} from 'path';
+import type {TypeDocOptions} from 'typedoc';
+import {baseTypedocConfig} from 'virmator/dist/compiled-base-configs/base-typedoc';
+
+const repoRoot = resolve(__dirname, '..');
+const indexTsFile = join(repoRoot, 'src', 'index.ts');
+
+export const typeDocConfig: Partial<TypeDocOptions> = {
+    ...baseTypedocConfig,
+    out: join(repoRoot, 'dist-docs'),
+    entryPoints: [
+        indexTsFile,
+    ],
+    intentionallyNotExported: [],
+};

configs/vite.config.ts

@@ -0,0 +1,14 @@
+import {resolve} from 'path';
+import {defineConfig} from 'virmator/dist/compiled-base-configs/base-vite';
+
+export default defineConfig(
+    {
+        forGitHubPages: true,
+        packageDirPath: resolve(__dirname, '..'),
+    },
+    (baseConfig) => {
+        return {
+            ...baseConfig,
+        };
+    },
+);

configs/web-test-runner.config.mjs

@@ -0,0 +1,21 @@
+import {dirname} from 'path';
+import {fileURLToPath, pathToFileURL} from 'url';
+import {getWebTestRunnerConfigWithCoveragePercent} from 'virmator/base-configs/base-web-test-runner.mjs';
+
+const baseConfig = getWebTestRunnerConfigWithCoveragePercent({
+    coveragePercent: 100,
+    packageRootDirPath: dirname(dirname(fileURLToPath(import.meta.url))),
+    extraScreenshotOptions: {},
+});
+
+/** @type {import('@web/test-runner').TestRunnerConfig} */
+const webTestRunnerConfig = {
+    ...baseConfig,
+};
+
+export default webTestRunnerConfig;
+
+// check if the current file is being run directly as a script
+if (import.meta.url === pathToFileURL(process.argv[1]).href) {
+    console.info(JSON.stringify(webTestRunnerConfig, null, 4));
+}

cspell.config.cjs

@@ -0,0 +1,13 @@
+const {baseConfig} = require('virmator/base-configs/base-cspell.js');
+
+module.exports = {
+    ...baseConfig,
+    ignorePaths: [
+        ...baseConfig.ignorePaths,
+    ],
+    words: [
+        ...baseConfig.words,
+        'farcaster',
+        'toniq',
+    ],
+};