JSPM

isite

1.4.3
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 23969
  • Score
    100M100P100Q133861F
  • License ISC

Create Fast & Easy Web Site with Full Development Features

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

Isite Help You To Create Your Node Js WebSite with Advanced Development 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]
    - 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 Tags]
    - MongoDB Full Integration
    - MD5 Hash Function  

Installation

npm install isite --save

Using

var isite = require('isite')
var site = isite() 

site.run()

Advanced Using

var isite = require('isite')
site = isite({
    port: 8080, // default 80
    dir: __dirname + '/site_files', //default ./site_files
    savingTime: 60 * 60, // default 60 * 60 - 1 hour
    sessionEnabled: true, // default true
    mongodbEnabled: true, // default false
    mongodbURL: '127.0.0.1:27017' // default 127.0.0.1:27017 - local
});

site.run()

Routes

  • Auto Convert All Routes URL & Parameters to Lower Case .

Easy and Auto Site Routing

site.addRoute({name: '/css/bootstrap.css',path:  site.dir + '/css/bootstrap.min.css'});
site.addRoute({
    name: '/js/script.js',
    path: [site.dir + '/js/jquery.js' , site.dir + '/js/bootstrap.js']
});
site.addRoute({name: '/',path:  site.dir + '/html/index.html'});
site.addRoute({name: '/api',path:  site.dir + '/json/employees.json' , method:'POST'});

site.get({
    name: '/fonts/fontawesome-webfont.woff2',
    path: site.dir + '/fonts/fontawesome-webfont.woff2'
})
site.get({
    name: '/favicon.png',
    path: site.dir + '/images/logo.png'
})

Advanced Site Routing

site.addRoute({
    name: '/',
    callback: function (req, res) {
        res.setHeader('Content-type', 'text/html');
        res.writeHead(200);
        site.html('index', function (err, content) {
            res.end(content);
        });
    }
});

site.addRoute({
    name: '/api',
    method: 'POST',
    callback: function (req, res) {
        res.setHeader('Content-type', 'application/json');
        res.writeHead(200);
        site.json('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]

site.get('/api', function(req, res) {
    res.end('GET | id : ' + req.url.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('/api/:post_id/category/:cat_id', function(req, res) {
    res.end('GET | postId : ' + req.url.query.post_id + ', catId : ' + req.url.query.cat_id)
})
//Example : http://127.0.0.1:7070/api/123456/category/99

MVC Custom Route

site.get("/:controller/:action/:arg1/:arg2", function(req, res) {
    res.end(
        "GET | Controller : " +
        req.url.query.controller +
        ", Action : " +
        req.url.query.action +
        ", Arg 1 : " +
        req.url.query.arg1 +
        ", Arg 2 : " +
        req.url.query.arg2
    );
});

Cookies

site.get('/api/set' , function(req , res){
    req.cookie.set('id' , 'userid')
      res.end('cookie set ok !!')
})

site.get('/api/get' , function(req , res){
      res.end(' id : ' + req.cookie.get('id'))
})

Sessions

site.get('/login', function(req, res) {
    req.session.set('username', 'amr barakat')
    res.end('loged ok !! ')
})

site.get('/userInfo', function(req, res) {
    var userName = req.session.get('username')
    res.end(userName)
})

Site Folder Structure

  • Create Folder Name "site_files" , inside it create these Sub folders [ html , css , js , json ]
  • 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);
});

MasterPages

add Custom Master Page And Using it ..

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'
});

Server Tags & Attributes

Add Custom Html Content

site.addRoute({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

//Create New Collection & Insert New Docs
site.post({
    name: '/db',
    callback: function (req, res) {
        site.mongodb.connectDB('company', function (err, db) {
            if (!err) {
                db.createCollection('employees')
                db.collection('employees').insertMany([{
                        name: 'Name 1',
                        phone: 'xxx'
                    },
                    {
                        name: 'Name 2',
                        phone: 'xxxxxx'
                    },
                    {
                        name: 'Name 3',
                        phone: 'xxxxxxxxxxx'
                    }
                ], function (err, result) {
                    db.close()
                    res.end('Data Inserted : ' + result.insertedCount)
                })

            } else {
                res.end(err.message)
            }
        })
    }
});

//Select Docs
site.get({
    name: '/db',
    callback: function (req, res) {
        site.mongodb.connectDB('company', function (err, db) {
            if (!err) {
                db.collection("employees").find({}).toArray(function (err, result) {
                    if (!err) {
                        res.end(JSON.stringify(result))
                    }
                    db.close()
                });
            } else {
                res.end(err.message)
            }
        })
    }
});

// Update Docs
site.put({
    name: '/db',
    callback: function (req, res) {
        site.mongodb.connectDB('company', function (err, db) {
            if (!err) {
                db.collection("employees").updateMany({
                    name: 'Name 1'
                }, {
                    $set: {
                        name: "Updated Name"
                    }
                }, function (err, result) {
                    if (!err) {
                        res.end('Data Updated : ' + result.result.nModified)
                    }
                    db.close()
                });
            } else {
                res.end(err.message)
            }
        })
    }
});

//Delete Docs
site.delete({
    name: '/db',
    callback: function (req, res) {
        site.mongodb.connectDB('company', function (err, db) {
            if (!err) {
                db.collection("employees").deleteMany({}, function (err, result) {
                    if (!err) {
                        res.end('Data Deleted !!')
                    }
                    db.close()
                });
            } else {
                res.end(err.message)
            }
        })
    }
});

MD5

site.md5('this content will be hashed as md5')

More