Codeigniter vite is a package that aims to integrate vitejs with codeigniter4 in a simple way.
- ⏱️ Almost zero configuration
- 🧩 Easy to install and remove
- 🔨 Easy to customize
- ✌️ Support most used frameworks:
react
,vue
, andsvlete
. (check v2 for SvelteKit support) - 🔥 Enjoy hot module replacement (HMR)
composer require mihatori/codeignitervite
then from your project root, run:
php spark vite:init --framework <framework>
replace <framework>
with vue
, react
, svelte
, or none
or you can just run:
php spark vite:init
our body spark
will handle the rest for you 🙃
- Install your node dependencies:
npm install
- Start vite server:
npm run dev
- Start CI server:
php spark serve
or access it through your virtual host. - That's all =)
NOTE:
npm run dev
is not where you should work, it main purpose is to serve assets, such as scripts or stylesheets. once you build your files, it becomes useless but as long as it running, the package will use it instead of the bundled files. So make sure to access your project from ci server or a vitual host.
to bundle your files, run:
npm run build
this command will generate the bundled assets in your public directory. but as we said before, as long as vite server is running, the package will use it instead of bundled files, so make sure to stop it when you're done developing.
composer remove mihatori/codeignitervite
command will remove the package, but the generated files will remain there (package.json, vite.config.js ...etc).
so to avoid that, make sure to run the following command first:
php spark vite:remove
This command will do the following:
- delete
package.json
,packages.lock.json
andvite.config.js
. - delete
resources
folder. - And finally restore your
.env
file.
Check out our starter apps for svelte and vue.
All contributions are welcome, it doesn't matter whether you can code, write documentation, or help find bugs. feel free to use issues or pull requests.
Unfortunately, I don't drink coffee 💔, but you can star it instead 🙃
MIT License © 2022 Mihatori Kei