JSPM

isite

1.2.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 26414
  • Score
    100M100P100Q132258F
  • 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

Features

    - Auto Routes [Simple & Advanced & Custom]  
    - Compain Multi Files Contents in One Route
    - Handle Request & Response Headers [Cookies - Parameters]
    - Auto Detect & Configer User Session  
    - Easy Creating Master Pages
    - Auto Caching & Management Files in Memory 
    - Fast Read Files Content [Site Folder Structure]
    - Custom Html Attributes [Server Tags]
    - MD5 Hash Function  

Installation

npm install isite --save

Using

var isite = require('isite')
var site = isite() // default port = 80 & dir = ./site_files

site.run()

Advanced Using

var isite = require('isite')
var site = isite({
    port:8080 , 
    dir:__dirname + '/site_files' //folder contains site files structure
    })

site.run()

Routes

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

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

Custom Route - Using * [any letters]

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

Request Parameters [GET , POST]

site.get('/employee', function(req, res) {
      res.end('ID : ' + req.url.query.id + ' , Name : ' + req.url.query.name)
})

site.post('/api/*', function(req, res) {
    res.end('ID : ' + req.body.id + ' , Name : ' + req.body.name)
})

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>

MD5

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

More