Skip to content

Commit b64ef80

Browse files
committed
Update docs
1 parent d7b237a commit b64ef80

File tree

2 files changed

+41
-0
lines changed

2 files changed

+41
-0
lines changed

docs/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
2+
# Codeigniter Vite Documentation
3+
4+
- [Installation](install.md)

docs/install.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Installation
2+
3+
`
4+
### IMPORTANT: 🚧 THIS DOCUMENTATION IS NOT YET COMPLETE (UNSTABLE) 🚧
5+
`
6+
7+
These instructions assume that you have already installed [composer](https://getcomposer.org/download/) and [CodeIgniter 4 app starter](https://codeigniter.com/user_guide/installation/installing_composer.html).
8+
9+
from your project root run:
10+
```
11+
composer require mihatori/codeignitervite
12+
```
13+
14+
then:
15+
```
16+
php spark vite:init
17+
```
18+
19+
or
20+
```
21+
php spark vite:init --framework <framework>
22+
```
23+
replace `<framework>` with `vue`, `react`, `svelte` or `none`.
24+
25+
That's all, you can now run `npm install`, `npm run dev` and start coding.
26+
27+
## What happened?
28+
29+
no need to explain composer command, but `php spark vite:init` did the hardest part.
30+
31+
let's make it clear:
32+
33+
- Generated `vite.config.js`, `package.json` in your project root.
34+
- Created a `resources` folder in you project root with the following files:
35+
- `main.js` - your frontend entry file.
36+
- Main component eg: `App.vue`, `App.svelte`, `App.jsx` depends on the framework you selected.
37+
- Added some useful variables in your `.env` file, make sure to check them out.

0 commit comments

Comments
 (0)