Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mihatorikei/ci-vue-appstarter

CodeIgniter 4 + Vue3 App Starter
https://github.com/mihatorikei/ci-vue-appstarter

codeigniter codeigniter4 pwa spa vite vitejs vuejs

Last synced: 2 months ago
JSON representation

CodeIgniter 4 + Vue3 App Starter

Host: GitHub
URL: https://github.com/mihatorikei/ci-vue-appstarter
Owner: mihatorikei
License: mit
Created: 2022-07-24T06:51:26.000Z (over 2 years ago)
Default Branch: master
Last Pushed: 2022-08-31T23:28:34.000Z (over 2 years ago)
Last Synced: 2024-10-01T00:41:20.708Z (3 months ago)
Topics: codeigniter, codeigniter4, pwa, spa, vite, vitejs, vuejs
Language: PHP
Homepage:
Size: 209 KB
Stars: 27
Watchers: 1
Forks: 2
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

CodeIgniter 4 + Vue3 Application Starter

## Features:
- 💡 Super fast single page application (SPA).
- 🔥 Hot Module Replacment (HMR).
- 🧩 Easy to install and update.
- 🪓 Easy to customize.
- 🔧 Zero Configuarations.
- ⭐ Progressive web application (PWA).
- ✨ And much more...

## Pre-packed:

> **Note:** none of these plugins or frameworks are required, feel free to remove or replace them as you like.
>
- [Windicss](https://windicss.org/): on-demand alternative to Tailwind, with bunch of additional cool features and much faster, (you can replace it with whenever css framework you like).
- [Axios](https://axios-http.com): A simple promise based HTTP client for the browser and node.js.
- [Vue Router](https://router.vuejs.org): official vue router plugin.
- [Vite Plugin Pages](https://github.com/hannoeru/vite-plugin-pages): a lightweight file system based routing.
- [Vite Plugin PWA](https://github.com/antfu/vite-plugin-pwa): zero config PWA plugin.

## Installation:

> Make sure your server meets [CI4 requirements](https://www.codeigniter.com/user_guide/intro/requirements.html).

run the following command to create a project:
```
composer create-project mihatori/ci-vue-appstarter
```

## Setup

- Copy `env` to `.env`.
- Run: `npm intall` to install node dependencies.
- Run: `npm run dev` to serve your assets.
- Now start you CI server: `php spark serve` or access it through you virtual host.

> **IMPORTANT:**
>
> after the installation, there will be no bundled assets, so make sure to run `npm run dev` to serve them or just build them with `npm run build` command.

## Customizing:
This project uses [**CodeIgniter Vite**](https://github.com/firtadokei/codeigniter-vitejs) package, [read more about it](https://github.com/firtadokei/codeigniter-vitejs).

## Something doesn't work fine:
Please feel free to open an issue and we will try to fix it on the fly.

## Contribuiting:
Literally any help will be appreciated, feel free to use PRs, and thanks in advance.