@elithica/cli
v1.0.10
Published
CLI to install Elithica
Downloads
671
Readme
#Elithica CLI
Elithica - A modular front-end framework for intuitive web development. Node/Express Version.
INSTALL
Note: This CLI uses Git at this time to pull the relevant selections. Make sure you have Git installed. A later version will remove this requirement.
npm install -g @elithica/cli
elithica
Known Issues
Recommended Usage
Node/Express
LAMP (Apache/PHP)
These two structures are similar, but differ with respect to minor routing. For example Apache requires an .htaccess file to direct routes to the single page application (SPA), while the Express install does not need them.
Framework Structure
root_folder
|-- css
|-- lib
|-- (css framework, optional)
|-- img
|-- logo
|-- js
|-- config
|-- main.menu.js
|-- main.template.js
|-- routes.js
|-- lib
|-- svg
|-- icons.js
|-- (jquery, optional)
|-- modules
|-- components
|-- COMING SOON!
|-- integrants
|-- COMING SOON!
home.mod.js
|-- utils
|-- fetch.Util.js
|-- valid.Util.js
app_legacy.js
app.js
index.html
How to Use and Customize
1) Edit the index.html Title and Metadata to match your project.
2) Edit the home.mod.js file with your own HTML and JavaScript
3) If you require an overall layout change, edit the js/config/main.template.js with your preferred page structure.
4) Require more pages in your SPA? Edit the js/config/routes.js file, then add a matching module in js/modules. Use the _template.mod.js file to get you started.
5) Further Customizations: By default Elithica comes with the Spectre CSS Framework and jQuery. These are optional tools. If you don't want them, just remove the reference from the index.html page and remove them from the relevant lib folders.