Hozz NPM | npm.io

Hozz - Wett Framework Cli & Project Architecture / Structure Guide

hozz is a architecture for wett JavaScript framework, with primary purpose of standardizing node js apis Structure for easy development cycle.

best JavaScript backend framework, organizing and structuring tools.

Best Practises

always use db operations with functions declared in the io directory add the io functions with the index using module.exports
always use new keys before going to production to make sessions secure.
follow the given wett modules structure to the tee it makes dev on boarding and dev cycle easy
always use wett logs for easy debugging.
functions which are needed to be used with multiple apis should be used as separate modules and be declared in elective directory and exported with module.exports in the index file.
please update wett api manually on regular interval we don't update it automatically.
all global modules like databases or file storage should be activated before the app initiator is called in the index file in the app directory, follow all the guidance given in the file for structuring your code.

Init

this command initiates a new project with the name given in the cli

$ hozz init akku

Generate

this command generates wett modules

$ hozz generate

Wett Modules

wett is a api framework, to give a easy structure to your backend, hozz uses modules to guide the developers through a location based system for organising your projects.

these modules are nested within with a tree structure

--app
    --api
        --method

App - Module

usually all the apps nowdays support multiple platforms, to organize platform specific or user group specific apis, top level module - app separates apis for backend, web, frontend, android, cordova, android, ios or platform specific apis.

Api - Module

each app needs to login, serve content and do user specific functions like login, singup, messaging api for ios or android.

Method - Module

methods are simple io operations like messaging may have both incoming and outgoing methods such different methods can be separated into different files for easy navigation and code management

Module Structure

Apps :-
    -ios
        Apis :-
            -login
                Methods :-
                    -get
                    -set
                    -update
            -post
            -stream
     -android
     -backend

Serve

this launches your app in development mode with live reloading on file changes and you can also press enter once your app is launched to restart the app.

$ hozz serve

Keys

this API makes RSA keys for WETT sessions these keys can be found in secure folder => "wett_keys.json" and are already included in the project, before production deploy please make new keys

$ hozz keys generate

to remake keys

$ hozz keys remake

**caution remake commands replaces your old keys.