Package Exports

isite

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (isite) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

This is Framework help You to Create Node Js WebSite with Many Featuers

Features

    - Auto Routes [Simple & Advanced & Custom]
    - Auto Handle File Types Encoding [Fonts - Images - ...]  
    - Merge Multi Files Contents in One Route
    - Auto Handle Request & Response Headers [Cookies - Parameters - params]
    - Auto Detect & Configer User Session  
    - Easy Creating Master Pages
    - Auto Caching & Management Site Files in Memory 
    - Fast Read Files Content [Site Folder Structure]
    - Custom Html Attributes [Server side Tags]
    - MongoDB Full Integration
    - Client libraries [jquery - bootstrap - font-awesome - angular]
    - Development Helper Functions
    - Site Dynamic Events Callback

Installation

npm install isite --save

Using

Fast Startup Web Server.

var isite = require('isite')
var site = isite({port:8080}) 

site.run()

Advanced Using with Custom Options.

var isite = require('isite')
site = isite({
    port: 54321,
    dir: __dirname + "/site_files",
    savingTime: 60,
    cache: {
        js: 60 * 24 * 30,
        css: 60 * 24 * 30,
        images: 60 * 24 * 30,
        fonts: 60 * 24 * 30
    },
    session: {
        enabled: true,
        storage: "mongodb",
        dbName: "sessions",
        userSessionCollection: "user_sessions"
    },
    security: {
        enabled: true,
        admin: {
            email: 'admin@localhost',
            password: 'p@ssw0rd'
        },
        users: [{
            _id: '0001',
            email: 'member1@localhost',
            password: '123456',
            permissions: ['showReports', 'addItems']
        }],
        storage: "mongodb",
        dbName: "security",
        userCollection: "users"
    },
    mongodb: {
        enabled: true,
        prefix: '',
        url: "127.0.0.1",
        port: "27017",
        userName: "",
        password: "",
        dbName: '',
        collectionName: ''
    }
});


site.run()

Site Folder Structure

site stucture help you to manage you site easy and fast
Create Folder Name "site_files"
inside it create these Sub folders [ html , css , js , json , fonts , images , xml , ... ]
To Easy Read File Contents From "site_files" Folder

site.html('index', function (err, content) {
    console.log(content);
});
site.css('bootstrap', function (err, content) {
    console.log(content);
});
site.js('jquery', function (err, content) {
    console.log(content);
});
site.json('items', function (err, content) {
    console.log(content);
});
site.xml('rss', function (err, content) {
    console.log(content);
});

Custom Read Files
- Read From Local File in First Time and save in memory
- next time Read Will be From Memory

//read file with custom header
site.get("/rss", function(req, res) {
    site.readFile(__dirname + "/site_files/xml/rss.xml", function(err, content) {
        res.writeHead(200, { "content-type": "text/xml" })
        res.end(content)
    })
})
site.get("/rss2", function(req, res) {
    site.xml("rss2", function(err, content) {
        res.writeHead(200, { "content-type": "text/xml" })
        res.end(content);
    })
})
//read multi files with custom header
site.get("/", function(req, res) {
    site.readFiles(
        [
            __dirname + "/site_files/html/head.html",
            __dirname + "/site_files/html/content.html",
            __dirname + "/site_files/html/footer.html"
        ],
        function(err, content) {
            res.writeHead(200, { "content-type": "text/html" });
            res.end(content);
        })
})

Routes

Auto Convert All Routes URL & Parameters to Lower Case
Auto Manage Reponse Headers and Files Types
Support Multi Files in One Route
Save Route Response in Memory to Reuse for Fast Response
Auto Handle URL parametes
Auto Handle Body Parameters in not get header [post , put , delete , ...]
Auto Handle URL params [custom parameters from url structure]
Auto cache Files Content in memory
support compress to remove unwanted spaces and tabs and empty lines ...etc
support parser to handle custom html server side tags

Easy and Auto Site Routing

site.get({name: '/',path:  site.dir + '/html/index.html'});
site.get({name: '/css/bootstrap.css',path:  site.dir + '/css/bootstrap.min.css'});
site.get({name: '/js/jquery.js',path: site.dir + '/js/jquery.js'});
site.get({name: '/js/bootstrap.js',path: site.dir + '/js/bootstrap.js'});
site.get({name: '/favicon.png',path: site.dir + '/images/logo.png'})
site.post({name: '/api',path:  site.dir + '/json/employees.json' });

Merge Multi Files in one route

site.get({
    name: '/css/style.css',
    path: [site.dir + '/css/bootstrap.css' , site.dir + '/css/custom.css']
});
site.get({
    name: '/js/script.js',
    path: [site.dir + '/js/jquery.js' , site.dir + '/js/bootstrap.js', site.dir + '/js/custom.js']
});

Advanced Site Routing

site.addRoute({ // can use [get , post , put , delete]
    name: '/',
    method: 'custom method', // dfeault - GET
    path: site.dir + '/html/index.html', // default null
    parser: 'html', // default static
    compress : true , // default false
    cache: false // default true
});

site.get({ // can use [get , post , put , delete]
    name: '/',
    path: site.dir + '/html/index.html', // default null
    parser: 'html', // default static
    compress : true , // default false
    cache: false // default true
});

site.addRoute({ // can use [get , post , put , delete]
    name: '/',
    method: 'custom method', // dfeault - GET
    callback: function(req, res) {
        res.setHeader('Content-type', 'text/html');
        res.writeHead(200);
        site.html('index', function(err, content) {
            res.end(content);
        });
    }
});

site.get({ // can use [get , post , put , delete]
    name: '/',
    callback: function(req, res) {
        res.setHeader('Content-type', 'text/html');
        res.writeHead(200);
        site.html('index', function(err, content) {
            res.end(content);
        });
    }
});

Auto Route All Files in Folder

site.get({name: '/js', path: __dirname + '/js'})
site.get({name: '/css', path: __dirname + '/css'})

Custom Route - Using * [any letters]

site.get('/post/*', function(req, res) {
    res.end('Any Route like /post/11212154545 ')
})
site.get('*', function(req, res) {
    res.end('Any Route Requested Not Handled Before This Code')
})

Request Parameters [GET , POST | PUT | Delete] Restful API

site.get('/api', function(req, res) {
    res.end('GET | id : ' + req.query.id)
})
site.post('/api', function(req, res) {
    res.end('POST | id : ' + req.body.id + ' , Name : ' + req.body.name)
})
site.put('/api', function(req, res) {
    res.end('PUT | id : ' + req.body.id + ' , Name : ' + req.body.name)
})
site.delete('/api', function(req, res) {
    res.end('Delete | id : ' + req.body.id)
})
site.all('/api', function(req, res) {
    res.end('Any Request Type Not Handled : ' + req.method)
})

Dynamic Parameters

site.get('/post/:id/category/:cat_id', function(req, res) {
    res.end('GET | Id : ' + req.params.id + ', catId : ' + req.params.cat_id)
})
//example : /post/9999999/category/5

MVC Custom Route

site.get("/:controller/:action/:arg1", function(req, res) {
    res.end(
        "GET | Controller : " + req.params.controller +
        ", Action : " + req.params.action +
        ", Arg 1 : " + req.params.arg1
    );
});
//example : /facebook/post/xxxxxxxxxx

Cookies

- cookie is client side data per user
- cookie is enabled by default

site.get("/setCookie", function(req, res) {
        req.cookie.set('name', req.query.name)
        res.end('cookie set')
})
//example : /setcookie?name=amr

site.get("/getCookie", function(req, res) {
        res.end('name from cookie : ' + req.cookie.get('name'))
})
//example : /getcookie

Sessions

- session is server side data per user
- every user has its own access token
- session is management automatic
- session save in memory by default

site.get('/setSession', function(req, res) {
    req.session.set('user_name', req.query.user_name)
    res.end('Session Set ok !! ')
})
//example : /setSession?user_name=absunstar

site.get('/getSession', function(req, res) {
    res.end('User Name from session : ' + req.session.get('user_name'))
})
//example : /getSession

Master Pages

- master page help you to not repate you code
- master page make site layout look good with less code
- master page is tow parts header and footer
- master page put content between header and footer

site.addMasterPage({
    name: 'masterPage1',
    header: site.dir + '/html/header.html',
    footer: site.dir + '/html/footer.html'
})

site.get({
    name: '/ContactUs',
    masterPage : 'masterPage1',
    path: site.dir + '/html/contact.html',
    parser: 'html'
});

HTML Server Tags & Attributes

- html server tags is html tags run in server side
- html server tags make html structure easy management
- html server tags is the next generation of html

Add Custom Html Content

site.get({name: '/',path:  site.dir + '/html/index.html' , parser:'html'});

<div x-import="navbar.html"></div>

<div class="container">
    <h2 > ... </h2>
    <p x-import="info.html"></p>
</div>

Page "navbar.html" & "info.html" Must Be In HTML Site Folder ['/site_files/html/']

Dynamic Varibles Sets

site.addVar('siteName', 'First Site With Isite Library ');
site.addVar('siteBrand', 'XSite');

<title>##var.siteName##</title>
<h2>##var.siteBrand##</h2>

MongoDB Integration

- Manage Closed Connections and Timeout
- Manage Multi Connections
- Manage Bulk Inserts & Updates & Deletes
- User Friendly Coding

// Insert One Doc
   site.mongodb.insertOne({
            dbName: 'company',
            collectionName: 'employess',
            doc:{name:'amr',salary:35000}
        }, function (err, docInserted) {
            if (err) {
                console.log(err.message)
            } else {
                console.log(docInserted)
            }
        })

// Insert Many Docs
   site.mongodb.insertMany({
            dbName: 'company',
            collectionName: 'employess',
            docs:[
                    {name:'amr',salary:35000} , 
                    {name:'Gomana',salary:9000} ,
                    {name:'Maryem',salary:7000}
                ]
        }, function (err, result) {
            if (err) {
                console.log(err.message)
            } else {
                console.log(result)
            }
        })

// Find One Doc
 site.mongodb.findOne({
            dbName: 'company',
            collectionName: 'employees',
            where:{},
            select : {}
        }, function (err, doc) {
            if (err) {
                console.log(err.message)
            } else {
                console.log(doc)
            }
        })

// Find Many Docs
 site.mongodb.findMany({
            dbName: 'company',
            collectionName: 'employees',
            where:{},
            select : {}
        }, function (err, docs) {
            if (err) {
                console.log(err.message)
            } else {
                console.log(docs)
            }
        })

//Update One Doc
           site.mongodb.updateOne({
            dbName: 'company',
            collectionName: 'employees',
            where:{salary:7000},
            set : {name:'New MARYEM'}
        }, function (err, result) {
            if (err) {
                console.log(err.message)
            } else {
                console.log(result)
            }
        })

// Update Many Docs
           site.mongodb.updateMany({
            dbName: 'company',
            collectionName: 'employees',
            where:{salary:9000},
            set : {salary:9000 * .10}
        }, function (err, result) {
            if (err) {
                console.log(err.message)
            } else {
                console.log(result)
            }
        })

// Delete One Doc
          site.mongodb.deleteOne({
            dbName: 'company',
            collectionName: 'employess',
            where:{_id: new site.mongodb.ObjectID('df54fdt8h3n48ykd136vg')}
        }, function (err, result) {
            if (err) {
                console.log(err.message)
            } else {
                console.log(result)
            }
        })
// Delete Many Docs
          site.mongodb.deleteMany({
            dbName: 'company',
            collectionName: 'employess',
            where:{name : /a/}
        }, function (err, result) {
            if (err) {
                console.log(err.message)
            } else {
                console.log(result)
            }
        })

Client libraries

Easy Access popular Client libraries

- no need to install any client library
- no need to install any fonts
- no need to manage library routes
- just use it

 <link rel="stylesheet" href="/@css/bootstrap3.css" >
 <link rel="stylesheet" href="/@css/font-awesome.css" >

 <script src="/@js/jquery.js"></script>
 <script src="/@js/bootstrap3.js"></script>
 <script src="/@js/angular.js"></script>

Helper Functions

var hash = site.md5('this content will be hashed as md5')
console.log(hash)

var name = 'absunstar'
if (name.like('*sun*')) {
    console.log('yes')
}

Events

- Events is global actions across site using emit events

site.on('event name', function() {
    console.log('you call event name')
})

site.call('event name')

- This Framework make Security and Safty in the First Place
- This Framework from Developer to Developers
- This Framework will be Free and Supported For Ever
- This Framework will Upgraded Arround the Clock for You
- This Framework Development by One Developer

Email : Absunstar@gmail.com
Linkedin : https://www.linkedin.com/in/absunstar
Github : https://github.com/absunstar

isite