rayelliott
/
octobercms-webpack-starter-theme
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

update readme

This commit is contained in:
Ray Elliott 2021-03-27 18:31:23 +00:00
parent 0b39daa89d
commit 167898f31b
1 changed files with 10 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -1,4 +1,5 @@
October CMS Webpack Theme Boilerplate
# October CMS Webpack Theme Boilerplate
==========
This is a starter theme for October CMS that includes:
@ -9,20 +10,15 @@ This is a starter theme for October CMS that includes:
To use it:
- [Install October CMS](https://octobercms.com/docs/setup/installation)
- Clone the repo in your theme directory
- Inside cloned directory run `npm install` (node_modules folder will be created)
- Install more packages using `npm install --save`
- Require your installed packages in src/js/app.js
- Modify the js and css files
- Run `npm run dev` (`npm run watch` to recompile when something changes, `npm run hot` to enable HMR)
- [Add new pages, partials, content files...](https://octobercms.com/docs/cms/themes)
- [Install October CMS](https://octobercms.com/docs/setup/installation).
- Clone the repo in October's `themes` directory.
- Inside cloned directory run `npm install`.
- Install more packages using `npm install --save`.
- Require your installed packages in `src/js/app.js`.
- Run `npm run dev` (`npm run watch` to recompile when something changes, `npm run hot` to enable HMR).
- Run `npm run prod` to compile for production.
When you are ready for production:
- Run `npm run prod`
## To add ajax framework
## To enable the Ajax framework
```sh
npm install jquery