{"id":17749332,"url":"https://github.com/ryanatkn/fuz_template","last_synced_at":"2025-04-01T18:31:11.504Z","repository":{"id":39655737,"uuid":"352777401","full_name":"ryanatkn/fuz_template","owner":"ryanatkn","description":"a static web app and Node library template for SvelteKit with TypeScript, Svelte, Vite, esbuild, Fuz, and Gro ❄","archived":false,"fork":false,"pushed_at":"2024-09-15T23:16:51.000Z","size":1433,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-09-16T00:37:36.598Z","etag":null,"topics":["esbuild","eslint","prettier","starter","starter-kit","svelte","sveltekit","template","typescript","vite"],"latest_commit_sha":null,"homepage":"https://template.fuz.dev/","language":"Svelte","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ryanatkn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"ryanatkn","patreon":"ryanatkn"}},"created_at":"2021-03-29T20:34:27.000Z","updated_at":"2024-09-15T23:16:45.000Z","dependencies_parsed_at":"2023-10-16T08:29:45.721Z","dependency_job_id":"c64afe4f-ec8c-4411-878e-4b883f917d90","html_url":"https://github.com/ryanatkn/fuz_template","commit_stats":null,"previous_names":["fuz-dev/fuz-template","fuz-dev/fuz_template","ryanatkn/fuz_template"],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryanatkn%2Ffuz_template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryanatkn%2Ffuz_template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryanatkn%2Ffuz_template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryanatkn%2Ffuz_template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ryanatkn","download_url":"https://codeload.github.com/ryanatkn/fuz_template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246691468,"owners_count":20818521,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["esbuild","eslint","prettier","starter","starter-kit","svelte","sveltekit","template","typescript","vite"],"created_at":"2024-10-26T11:22:51.440Z","updated_at":"2025-04-01T18:31:11.497Z","avatar_url":"https://github.com/ryanatkn.png","language":"Svelte","funding_links":["https://github.com/sponsors/ryanatkn","https://patreon.com/ryanatkn"],"categories":[],"sub_categories":[],"readme":"# @ryanatkn/fuz_template ❄\n\n[\u003cimg src=\"/static/logo.svg\" alt=\"a friendly pixelated spider facing you\" align=\"right\" width=\"192\" height=\"192\"\u003e](https://template.fuz.dev/)\n\n\u003e a static web app and Node library template with\n\u003e [TypeScript](https://github.com/microsoft/TypeScript),\n\u003e [Svelte](https://github.com/sveltejs/svelte),\n\u003e [SvelteKit](https://github.com/sveltejs/kit),\n\u003e [Vite](https://github.com/vitejs/vite),\n\u003e [esbuild](https://github.com/evanw/esbuild),\n\u003e [Fuz](https://github.com/ryanatkn/fuz),\n\u003e and [Gro](https://github.com/ryanatkn/gro)\n\n[**template.fuz.dev**](https://template.fuz.dev/)\n\n## contents\n\n- [SvelteKit](https://github.com/sveltejs/kit) with [Svelte](https://github.com/sveltejs/svelte) and\n  [Vite](https://github.com/vitejs/vite)\n- [Moss](https://github.com/ryanatkn/moss): CSS framework and design system based on style variables\n- [Fuz](https://github.com/ryanatkn/fuz):\n  - Svelte UI library - [fuz.dev](https://www.fuz.dev/)\n  - is optional, to remove, `npm uninstall @ryanatkn/fuz` and delete the imports\n- [Gro](https://github.com/ryanatkn/gro):\n  - extends [SvelteKit](https://github.com/sveltejs/kit) and\n    [Vite](https://github.com/vitejs/vite)\n  - integrated [TypeScript](https://github.com/microsoft/TypeScript)\n    with [Svelte](https://github.com/sveltejs/svelte) and\n    [svelte-check](https://github.com/sveltejs/language-tools/tree/master/packages/svelte-check)\n  - testing with [uvu](https://github.com/lukeed/uvu)\n  - formatting with [Prettier](https://github.com/prettier/prettier)\n  - linting with [ESLint](https://github.com/eslint/eslint)\n    and [`@ryanatkn/eslint-config`](https://github.com/ryanatkn/eslint-config)\n  - also has [a task system](https://github.com/ryanatkn/gro/blob/main/src/lib/docs/task.md)\n    with a bunch of [builtins](https://github.com/ryanatkn/gro/blob/main/src/lib/docs/tasks.md),\n    [codegen](https://github.com/ryanatkn/gro/blob/main/src/lib/docs/gen.md),\n    and [other things](https://github.com/ryanatkn/gro/tree/main/src/lib/docs)\n- optional [utilities library `@ryanatkn/belt`](https://github.com/ryanatkn/belt)\n\n## usage\n\nThis project uses [SvelteKit](https://kit.svelte.dev/) with the static adapter\nand [Vite](https://vitejs.dev/),\nso the normal commands like `vite dev` work as expected.\nIt also uses [Gro](https://github.com/ryanatkn/gro)\nfor tasks like deploying and more.\n\n**⚠️ Important,** this template is designed for **public** open source projects.\nIts `package.json` has `\"public\": true` by default,\nwhich [tells Gro](https://github.com/ryanatkn/gro/blob/main/src/lib/docs/gro_plugin_sveltekit_frontend.md#well_known_package_json)\nto publish the `package.json` and a map of its `src/` directory\nto `static/.well-known/` during the build.\nThis can leak sensitive information if you are not careful ⚠️\nTo disable the feature, edit [package.json](/package.json):\n\n```diff\n// package.json\n- \"public\": true, // remove this to disable the public `.well-known` files\n+ \"private\": true, // if you want to disable npm publishing, add this\n```\n\n\u003e [Windows will not be suported](https://github.com/ryanatkn/fuz_template/issues/4)\n\u003e because I chose Bash instead - [WSL](https://docs.microsoft.com/en-us/windows/wsl/about) works\n\nIf you're logged into GitHub, click \"Use this template\" above or clone with\n[`degit`](https://github.com/Rich-Harris/degit):\n\n```bash\nnpx degit ryanatkn/fuz_template cooltoy\ncd cooltoy\nnpm i\n# then\nvite dev\n# or\nnpm run dev\n# or\ngro dev # npm i -g @ryanatkn/gro\ngro sync # called by `gro dev`, refreshes generated files and calls `svelte-kit sync`\n```\n\n\u003e learn more about [SvelteKit](https://github.com/sveltejs/kit),\n\u003e [Vite](https://github.com/vitejs/vite), [Gro](https://github.com/ryanatkn/gro),\n\u003e and [Fuz](https://github.com/ryanatkn/fuz)\n\nThe template includes\n[`@sveltejs/adapter-static`](https://github.com/sveltejs/kit/tree/master/packages/adapter-static)\nso it can [deploy](https://github.com/ryanatkn/gro/blob/main/src/lib/docs/deploy.md)\nwith no further configuration.\nTo learn how to swap it out for another deployment target, see\n[the SvelteKit adapter docs](https://kit.svelte.dev/docs#adapters).\n\nTo make it your own, change `@ryanatkn/fuz_template` and `template.fuz.dev`\nto your project name in the following files:\n\n- [`package.json`](package.json)\n- [`svelte.config.js`](svelte.config.js)\n- [`src/routes/+layout.svelte`](src/routes/+layout.svelte)\n- [`src/routes/+page.svelte`](src/routes/+page.svelte)\n- update or delete [`src/static/CNAME`](src/static/CNAME)\n  and [.github/FUNDING.yml](.github/FUNDING.yml)\n\nThen run `npm i` to update `package-lock.json`.\n\nOptionally add a [license file](https://choosealicense.com/)\nand [`package.json` value](https://spdx.org/licenses/), like `\"license\": \"MIT\"`.\n\n## build\n\n```bash\nnpm run build\n# or\ngro build\n```\n\nSee [Gro's build docs](https://github.com/ryanatkn/gro/blob/main/src/lib/docs/build.md) for more.\n\n## test\n\n```bash\nnpm test\n# or\ngro test\ngro test filepattern1 filepatternB\ngro test -- uvu --forwarded_args 'to uvu'\n```\n\nSee [uvu](https://github.com/lukeed/uvu),\n[`src/lib/example.test.ts`](src/lib/example.test.ts),\nand [Gro's test docs](https://github.com/ryanatkn/gro/blob/main/src/lib/docs/test.md) for more.\n\n## deploy\n\n[Deploy](https://github.com/ryanatkn/gro/blob/main/src/lib/docs/deploy.md)\n(build, commit, and push) to the `deploy` branch, e.g. for GitHub Pages:\n\n```bash\nnpm i -D @sveltejs/package # enables Gro's library plugin by default\nnpm run deploy\n# or\ngro deploy\n```\n\n## credits 🐢\u003csub\u003e🐢\u003c/sub\u003e\u003csub\u003e\u003csub\u003e🐢\u003c/sub\u003e\u003c/sub\u003e\n\n[Svelte](https://github.com/sveltejs/svelte) ∙\n[SvelteKit](https://github.com/sveltejs/kit) ∙\n[Vite](https://github.com/vitejs/vite) ∙\n[esbuild](https://github.com/evanw/esbuild) ∙\n[uvu](https://github.com/lukeed/uvu) ∙\n[TypeScript](https://github.com/microsoft/TypeScript) ∙\n[ESLint](https://github.com/eslint/eslint) ∙\n[Prettier](https://github.com/prettier/prettier) ∙\n[Moss](https://github.com/ryanatkn/moss) ∙\n[Fuz](https://github.com/ryanatkn/fuz) ∙\n[Gro](https://github.com/ryanatkn/gro) ∙\n[@ryanatkn/belt](https://github.com/ryanatkn/belt) ∙\n[Zod](https://github.com/colinhacks/zod) ∙\n\u0026 [more](package.json)\n\n## [🐦](https://wikipedia.org/wiki/Free_and_open-source_software)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryanatkn%2Ffuz_template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fryanatkn%2Ffuz_template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryanatkn%2Ffuz_template/lists"}