{"id":18849416,"url":"https://github.com/chkilel/vitawind","last_synced_at":"2025-04-14T08:42:24.306Z","repository":{"id":43805809,"uuid":"504880876","full_name":"chkilel/vitawind","owner":"chkilel","description":"The best vitamine for your OctoberCMS theme, some Vitejs 🚅  with some Tailwind 🍃 and a lot of creativity  🚀","archived":false,"fork":false,"pushed_at":"2022-12-31T15:11:19.000Z","size":1005,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-27T22:13:29.046Z","etag":null,"topics":["octobercms","octobercms-theme","tailwind","tailwindcss","vite","vitejs","wintercms","wintercms-theme"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chkilel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-06-18T15:30:09.000Z","updated_at":"2024-09-17T07:17:48.000Z","dependencies_parsed_at":"2023-01-31T19:15:59.883Z","dependency_job_id":null,"html_url":"https://github.com/chkilel/vitawind","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chkilel%2Fvitawind","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chkilel%2Fvitawind/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chkilel%2Fvitawind/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chkilel%2Fvitawind/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chkilel","download_url":"https://codeload.github.com/chkilel/vitawind/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248849492,"owners_count":21171584,"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":["octobercms","octobercms-theme","tailwind","tailwindcss","vite","vitejs","wintercms","wintercms-theme"],"created_at":"2024-11-08T03:19:40.149Z","updated_at":"2025-04-14T08:42:24.285Z","avatar_url":"https://github.com/chkilel.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align='center'\u003eVitawind theme\u003c/h1\u003e\n\n\u003cp align='center'\u003e\u003ca href=\"https://github.com/tailwindlabs/tailwindcss\"\u003e💨 Tailwind CSS\u003c/a\u003e and \u003ca href=\"https://github.com/vitejs/vite\"\u003e ⚡️Vite\u003c/a\u003e, for \u003ca href=\"https://octobercms.com\"\u003e 🍂 OctoberCMS\u003c/a\u003e  \u0026 \u003ca href=\"https://wintercms.com/\"\u003e❄️ WinterCMS\u003c/a\u003e\u003cbr\u003e\n\u003c/p\u003e\n\u003cbr/\u003e\n\u003cbr/\u003e\n\u003cp align='center'\u003e\n  \u003cimg src='https://res.cloudinary.com/chkilel/image/upload/v1655656695/vitawind-theme/Github-preview_rqysbq.png' alt='Vitawind' width='50%'/\u003e\n\u003c/p\u003e\n\u003cbr/\u003e\n\n## Installation\n\nGo to your backend to **Settings \u003e System \u003e Updates \u0026 Plugins** and install the theme `Chkilel.Vitawind`, then install the `VitewindManager` Plugin. (just copy \u0026 paste the PluginID below and put it in the search box.)\n```\n    - Chkilel.VitewindManager\n```\n\u003e Cannot work without Vitewind Manager plugin, please install it to use the theme.\n\n## Theme Setup\n\nYou must first install the theme dependencies. **In the theme folder**, run:\n\n```\nnpm install // or yarn install\n```\n\n## Theme settings\nGo to your backend to **Settings \u003e Vitewind theme**, and configure the following settings:\n\n![Setting Vitewind](./assets/images/settings.png)\n\n        Environment:\n            - Use `.env` configuration  : will use the `APP_ENV` value in the .env file\n            - Development               : if you are working on the theme development (npm run dev)\n            - Production                : if you are in production, the theme must be built before (npm run build)\n\n        Port number : Enter the port on which the theme dev server is running (when you run `npm run dev`), default to 3000.\n\n        Theme: select the appropiate theme, if you modify the theme name in the `theme.yaml` file.\n\n\n## Vite config file\n\n\u003e - If you rename the theme folder, please adjust the name [VITAWIND_FOLDER] in `vite.config.js` accordingly.\n\u003e - If you need many JS files for your layouts, add them all to the `build.rollupOptions.input` config array to be compiled.\n\n```javascript\nimport WindiCSS from 'vite-plugin-windicss'\nexport default ({command}) =\u003e ({\n    base: command === 'serve' ? '' : '/themes/[VITAWIND_FOLDER]/public/build/', // Addjust the name of the theme\n    publicDir: 'fake_dir_so_nothing_gets_copied',\n    processCssUrls: true,\n    build: {\n        manifest: true,\n        outDir: 'public/build',\n        rollupOptions: {\n            input: [\n                'resources/js/app.js',\n                'resources/js/home.js',\n                // Add here all the files you need if you load different javascript code in each layout\n                'ressource/js/myFirstAddedFile.js',\n                'ressource/js/mySecondAddedFile.js',\n                ...\n            ],\n        },\n    },\n    plugins: [...],\n});\n```\n\n## Layout component\n\nThe **Vitewind plugin** register a layout component to inject JS and CSS assets,manage **hot reload** in Development and inject **build assets** in production.\n\n![Layout component](./assets/images/layout-component.png)\n\nPut the component in the layout and set the JS files you need to load for each layout, you can use different JS files for each layout.\n\n![Layout component](./assets/images/layout-component-settings.png)\n\n\n## Development\nRun the command below in your theme folder:\n\n```\nnpm run dev // or yarn dev\n\n```\nThe theme DEV server will start on `http://localhost:3000/` and listen to any modification in your `.htm` files ( layouts, pages, partials,...).\nthen, you can visite your site on its usual URL and start development.\n\n\u003e Note the **port of the dev server**, if different from 3000 you need to adjust it in the backend settings.\n\n## Production build\n\nUse `npm run build` to compile your assets.\n\n```\nnpm run build // or yarn build\n```\n\u003e Don't forget to adjust the `Enviroment` to **production** in the backend settings.\n\n## Theme License\n\nMIT License - check out [LICENSE](LICENSE) file for MIT license details.\n\n## Changelog\n\n#### 1.0.0 : initial release\n- Vitawind: the power of Tailwind CSS and the speed of Vite JS\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchkilel%2Fvitawind","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchkilel%2Fvitawind","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchkilel%2Fvitawind/lists"}