{"id":13417117,"url":"https://github.com/xbmlz/vitesse-solid","last_synced_at":"2025-04-14T21:53:53.054Z","repository":{"id":64847405,"uuid":"576234803","full_name":"xbmlz/vitesse-solid","owner":"xbmlz","description":"🏕 Opinionated Vite + SolidJS Starter Template","archived":false,"fork":false,"pushed_at":"2023-12-07T02:58:42.000Z","size":1371,"stargazers_count":64,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-14T21:53:35.163Z","etag":null,"topics":["solidjs","solidjs-boilerplate","solidjs-starter","solidjs-template","vite","vite-starter"],"latest_commit_sha":null,"homepage":"https://vitesse-solid.netlify.app/","language":"TypeScript","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/xbmlz.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},"funding":{"github":"xbmlz"}},"created_at":"2022-12-09T10:30:46.000Z","updated_at":"2024-10-06T12:15:32.000Z","dependencies_parsed_at":"2024-01-07T18:03:47.251Z","dependency_job_id":"a5489c16-f3c5-426c-a854-c1683099de3f","html_url":"https://github.com/xbmlz/vitesse-solid","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xbmlz%2Fvitesse-solid","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xbmlz%2Fvitesse-solid/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xbmlz%2Fvitesse-solid/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xbmlz%2Fvitesse-solid/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xbmlz","download_url":"https://codeload.github.com/xbmlz/vitesse-solid/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248968755,"owners_count":21191158,"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":["solidjs","solidjs-boilerplate","solidjs-starter","solidjs-template","vite","vite-starter"],"created_at":"2024-07-30T22:00:32.678Z","updated_at":"2025-04-14T21:53:53.021Z","avatar_url":"https://github.com/xbmlz.png","language":"TypeScript","funding_links":["https://github.com/sponsors/xbmlz"],"categories":["Get Started","Variations","vite"],"sub_categories":["Templates","Dev tools"],"readme":"\u003cp align='center'\u003e\n  \u003cimg src='https://user-images.githubusercontent.com/11247099/154486817-f86b8f20-5463-4122-b6e9-930622e757f2.png' alt='Vitesse - Opinionated Vite Starter Template' width='600'/\u003e\n\u003c/p\u003e\n\n\u003cp align='center'\u003e\nMocking up web app with \u003cb\u003eVitesse for SolidJS\u003c/b\u003e\u003csup\u003e\u003cem\u003e(speed)\u003c/em\u003e\u003c/sup\u003e\u003cbr\u003e\n\u003c/p\u003e\n\n\u003cbr\u003e\n\n\u003cp align='center'\u003e\n\u003ca href=\"https://vitesse-solid.netlify.app/\"\u003eLive Demo\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cbr\u003e\n\n\u003cp align='center'\u003e\n\u003cb\u003eEnglish\u003c/b\u003e | \u003ca href=\"https://github.com/xbmlz/vitesse-solid/blob/main/README.zh-CN.md\"\u003e简体中文\u003c/a\u003e\n\u003c!-- Contributors: Thanks for getting interested, however we DON'T accept new transitions to the README, thanks. --\u003e\n\u003c/p\u003e\n\n\u003cbr\u003e\n\n\n## Features\n\n- ⚡️ [SolidJS](https://github.com/solidjs/solid), [Vite 3](https://github.com/vitejs/vite), [pnpm](https://pnpm.io/), [ESBuild](https://github.com/evanw/esbuild) - born with fastness\n\n- 🗃️ [File based routing](./src/routes)\n\n- 📦 [Components auto importing](./src/components)\n\n- 📑 [Layout system](./src/layouts)\n\n- 📲 [PWA](https://github.com/antfu/vite-plugin-pwa)\n\n- 🎨 [UnoCSS](https://github.com/antfu/unocss) - the instant on-demand atomic CSS engine\n\n- ⚒️ [Solid Primitives](https://github.com/solidjs-community/solid-primitives) - A library of high-quality primitives that extend SolidJS reactivity.\n\n- 😃 [Use icons from any icon sets with classes](https://github.com/antfu/unocss/tree/main/packages/preset-icons)\n\n- 🌍 [I18n ready](./src/locales)\n\n- 🗒 [Markdown Support](./src/pages/about.md)\n\n- 📥 [APIs auto importing](https://github.com/antfu/unplugin-auto-import) - use Composition API and others directly\n\n- 🖨  CSR, SSR, streaming SSR, or SSG via\n\n- 🦔 Critical CSS via [critters](https://github.com/GoogleChromeLabs/critters)\n\n- ⚙️ Unit Testing with [Vitest](https://github.com/vitest-dev/vitest), E2E Testing with [Cypress](https://cypress.io/) on [GitHub Actions](https://github.com/features/actions)\n\n- ☁️ Deploy on Netlify, zero-config\n\n- ⚗️ [Tauri Desktop App](https://tauri.app/) - build desktop apps with SolidJS\n\n\u003cbr\u003e\n\n\n## Pre-packed\n\n### UI Frameworks\n\n- [UnoCSS](https://github.com/antfu/unocss) - The instant on-demand atomic CSS engine.\n\n### Icons\n\n- [Iconify](https://iconify.design) - use icons from any icon sets [🔍Icônes](https://icones.netlify.app/)\n- [Pure CSS Icons via UnoCSS](https://github.com/antfu/unocss/tree/main/packages/preset-icons)\n\n### Plugins\n\n- [SolidJS](https://start.solidjs.com/) - A declarative, efficient, and flexible JavaScript library for building user interfaces.\n- [`unplugin-auto-import`](https://github.com/antfu/unplugin-auto-import) - Directly use Vue Composition API and others without importing\n- [`vite-plugin-pwa`](https://github.com/antfu/vite-plugin-pwa) - PWA\n- [`solid-primitives`](https://github.com/solidjs-community/solid-primitives) - A library of high-quality primitives that extend SolidJS reactivity.\n\n### Coding Style\n\n- [ESLint](https://eslint.org/) with [@xbmlz/eslint-config](https://github.com/xbmlz/eslint-config), single quotes, no semi, auto fix on save\n\n### Dev tools\n\n- [TypeScript](https://www.typescriptlang.org/)\n- [Vitest](https://github.com/vitest-dev/vitest) - Unit testing powered by Vite\n- [Cypress](https://cypress.io/) - E2E testing\n- [pnpm](https://pnpm.js.org/) - fast, disk space efficient package manager\n- [Netlify](https://www.netlify.com/) - zero-config deployment\n- [VS Code Extensions](./.vscode/extensions.json)\n  - [Iconify IntelliSense](https://marketplace.visualstudio.com/items?itemName=antfu.iconify) - Icon inline display and autocomplete\n  - [i18n Ally](https://marketplace.visualstudio.com/items?itemName=lokalise.i18n-ally) - All in one i18n support\n  - [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)\n\n## Variations\n\nAs this template is strongly opinionated, the following provides a curated list for community-maintained variations with different preferences and feature sets. Check them out as well. PR to add yours is also welcome!\n\n## Try it now!\n\n\u003e Vitesse-solid requires Node \u003e=16\n\n### GitHub Template\n\n[Create a repo from this template on GitHub](https://github.com/xbmlz/vitesse-solid/generate).\n\n### Clone to local\n\nIf you prefer to do it manually with the cleaner git history\n\n```bash\nnpx degit xbmlz/vitesse-solid my-vitesse-solid-app\ncd my-vitesse-solid-app\npnpm i # If you don't have pnpm installed, run: npm install -g pnpm\n```\n\n## Checklist\n\nWhen you use this template, try follow the checklist to update your info properly\n\n- [ ] Change the author name in `LICENSE`\n- [ ] Change the title in `App.vue`\n- [ ] Change the hostname in `vite.config.ts`\n- [ ] Change the favicon in `public`\n- [ ] Remove the `.github` folder which contains the funding info\n- [ ] Clean up the READMEs and remove routes\n\nAnd, enjoy :)\n\n## Usage\n\n### Development\n\nJust run and visit http://localhost:3333\n\n```bash\npnpm dev\n```\n\n### Build\n\nTo build the App, run\n\n```bash\npnpm build\n```\n\nAnd you will see the generated file in `dist` that ready to be served.\n\n### Deploy on Netlify\n\nGo to [Netlify](https://app.netlify.com/start) and select your clone, `OK` along the way, and your App will be live in a minute.\n\n### Docker Production Build\n\nFirst, build the vitesse-solid image by opening the terminal in the project's root directory.\n\n```bash\ndocker buildx build . -t vitesse-solid:latest\n```\n\nRun the image and specify port mapping with the `-p` flag.\n\n```bash\ndocker run --rm -it -p 8080:80 vitesse-solid:latest\n```\n\n### Tauri Desktop App\n\nTo develop the Tauri Desktop App, run\n\n```bash\npnpm tauri:dev\n```\n\nTo build the Tauri Desktop App, run\n\n\u003e You can refer to [Tauri's documentation](https://tauri.studio/en/docs/getting-started/intro) for more information.\n\n```bash\npnpm tauri:build\n```\n\n## Why\n\nI have created several Vite apps recently. Setting the configs up is kinda the bottleneck for me to make the ideas simply come true within a very short time.\n\nSo I made this starter template for myself to create apps more easily, along with some good practices that I have learned from making those apps. It's strongly opinionated, but feel free to tweak it or even maintain your own forks. [(see community maintained variation forks)](#variations)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxbmlz%2Fvitesse-solid","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxbmlz%2Fvitesse-solid","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxbmlz%2Fvitesse-solid/lists"}