Liteframer NPM

An fast and easy to use application bootstrapping tool for node.

To install

npm install -g liteframer

usage

To create a new application ...

On the command line, navigate to the directory where you would like to start your application then type :

liteframer appName

Note:

The appName provided will be turned into lowercase
Spaces are not allowed in the appName unless you use escape characters e.g liteframer My Application can be typed as liteframer My\ \Application The result of this will however be my_application
The new application directory will be created in the current working directory ($PWD) at the time of running the command.

A Brief Introduction

Bixbyte's liteframer rapid app development framework base relies primarily on the UIKit and AngularJs frameworks for UI development.

it can also easily be ported as a UI base for mobile applications.

liteframer UI builder is built out of the box to interact Bixbyte's liteframe application base which is a rapid API development framework complete with a GraphQl like ORM with built in simple yet powerful user access control management.

This aids in the rapid development of a full stack application essentially following an MVC ish architecture.

Some of the things that come with liteframe *and therefore available in liteframer* by default are:

A socket.io and CORS enabled standardized express based server - base application
A simple communications module for email sending via the nodemailer mailer
A simple Branded SMS sender module premium rate api
sql promise based query handler complete with an easy to use 'no alteration required' ORM.
A simple gulp based javascript framework packaging module that allows for customization of the default shipped angular modules

APP STRUCTURE

| appName

  => assets	  

     -> css
	 	-> fonts
		-> themes
		- + .css

	 -> img 

	 -> icons
	 	-> material-design-icons

	 -> js
	 	-> maps
		- & .js

  => config
		- app.json
		+ & config.js
		- app-routes.json
		- passport.js

These files are to be created manually
		* & jwt-secret.conf
		* & email.conf
		* & sql.conf
		* & postgres.conf
		* & sms.conf
These files are to be created manually

  => db

SQL ORM HANDLER

  		& .js	

  => routes

  	 => templates

	   	=> welcome
		   	+ *.html

		=>password
			+ *.html

	 & auth.js
	 & db.js
	 & main.js
	 & passwords.js
	 & payments.js
	 & sms.js
	 & template2sms.js
	 & upload.js

  => sample

	  - sample.json

  => schema

	 - sample.sql

  => server
		 & enc_dec.js
		 & gcm.js
		 & mail.js
		 + & server.js
		 + server_cleanup.js
		 & sms.js
		 & sms_actions.js

  =>src

	=> framework

		+ & framify.es6		

	+ & app.es6
  
  
  => views

  		 & login.html
		 & signup.html
		 & manage_users.html
		 & passwords.html

		 -+ index.html
		 -+ dash.html
		 -+ panel.html

		 - *.html 

  & gulpfile.js
  & index.html
  & main.js
  + package.json

KEY

(=>)			Primary Major Segment folder

(->)			Subsidiary folder

(*) Files that require to be created at project initialization

(-) 			Mainly User genrated files ( ***Edit at will*** )

(+) 			Pre - existing configuration files ( ***Edit with some caution*** )

(&) 			Fragile Major configuration files ( ***Edit only if you are sure of what tou are doing*** )

(%) 			Auto -generated application files ( ***Edit to play a frustrating game of 'chasing the wind and wild geese'*** )

handling files in src/ {{ services | directives | controllers }}

Make your main controller and directive changes in the framework/framify.es6 file

Note:

*This file is required to run the application*

[ Editing it carelessly may prove as fruitful as chasing the wind with the sole purpose being to catch and jail it for causing hurricanes ]

Edit the app.es6 file such that all your application files are included therein* )
[*Failure to do this may mean that you have to implement an even dirtier routing mechanism*]