You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+30-9Lines changed: 30 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,23 +41,44 @@ php spark vite:init
41
41
42
42
our body `spark` will handle the rest for you 🙃
43
43
44
-
💥 **That's it**
45
-
you can now run `npm install`, `npm run dev` and enjoy
44
+
## Getting Started:
45
+
- Install your node dependencies: `npm install`
46
+
- Start vite server: `npm run dev`
47
+
- Start CI server: `php spark serve` or access it through your virtual host.
48
+
- That's all =)
49
+
50
+
> **NOTE:**
51
+
>
52
+
> `npm run dev` is not where you should work, it main purpose is to serve assets, such as scripts or stylesheets.
53
+
> once you build your files, it becomes useless
54
+
> but as long as it running, the package will use it instead of the bundled files.
55
+
> So make sure to **access your project** from ci server or a vitual host.
56
+
57
+
## Build your files:
58
+
59
+
to bundle your files, run:
60
+
```
61
+
npm run build
62
+
```
63
+
this command will generate the bundled assets in your public directory.
64
+
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.
46
65
47
-
## Uninitialize
48
-
You can run the following command to uninitialize it:
66
+
## Uninitialize:
67
+
68
+
`composer remove mihatori/codeignitervite` command will remove the package, but the generated files will remain there (package.json, vite.config.js ...etc).
69
+
so to avoid that, make sure to run the following command first:
49
70
50
71
```
51
72
php spark vite:remove
52
73
```
53
-
then you can run `composer remove mihatori/codeignitervite` to remove it completely.
54
-
55
-
### additional:
56
-
You will find some new variables in your `.env` file, you can change them as you like.
74
+
This command will do the following:
75
+
- delete `package.json`, `packages.lock.json` and `vite.config.js`.
76
+
- delete `resources` folder.
77
+
- And finaly restore your `.env` file.
57
78
58
79
## Contributing
59
80
All contributions are welcome, it doesn't matter whether you can code, write documentation, or help find bugs.
60
-
feel free to use issues tracker or pull requests
81
+
feel free to use issues or pull requests.
61
82
62
83
## What next?
63
84
More informations will be available as soon as possible ❤️.
0 commit comments