- 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
- Builtin Security System [register , login , permissions]
- Easy Creating Master Pages
- Auto Caching & Management Site Files in Memory
- Fast Read Files Content [Site Folder Structure]
- [ Upload / Download ] Files
- Custom Html Attributes [Server side Tags]
- MongoDB Full Integration
- Client libraries [jquery - bootstrap - font-awesome - angular]
- Development Helper Functions
- Site Dynamic Events Callback
npm install isite --save
var isite = require('isite')
var site = isite({port:8080})
site.run()
var isite = require('isite')
site = isite({
port : process.env.port || 80,
dir : './site_files',
savingTime : 60,
session : {
timeout : 60 * 24 * 30 ,
enabled : true,
storage : 'mongodb',
dbName : 'sessions' ,
userSessionCollection : 'user_sessions'
},
mongodb : {
enabled : true,
url :'127.0.0.1',
port : '27017',
userName : null,
password : null,
prefix : {
db:'',
collection:''
}
},
security :{
enabled : true,
dbName : 'security',
userCollection :'users',
admin:{
email : 'admin@localhost',
password : 'admin'
},
users:[]
},
cache:{
enabled : true,
js : 60 * 24 * 30,
css : 60 * 24 * 30,
fonts : 60 * 24 * 30,
images : 60 * 24 * 30,
json : 60 * 24 * 30,
xml : 60 * 24 * 30,
}
})
site.run()
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 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);
})
})
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.get({ // can use [get , post , put , delete , all]
name: '/',
path: site.dir + '/html/index.html', // default null
parser: 'html', // default static
compress : true , // default false
cache: false // default true
});
site.get({
name: '/',
callback: function(req, res) {
res.setHeader('Content-type', 'text/html');
res.writeHead(200);
site.html('index', function(err, content) {
res.end(content);
})
}
})
site.get('/', (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 + /* Normal case*/
", action : " + req.params.action + /* lower case*/
", Arg 1 : " + req.params.Arg1 + /* Normal case*/
", arg 1 : " + req.params.arg1 /* lower case*/
);
});
//example : /facebook/post/xxxxxxxxxx
- cookie is client side data per user
- cookie is enabled by default
site.get("/setCookie", function(req, res) {
res.cookie('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('name'))
})
//example : /getcookie
- 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 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 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/']
site.var('siteName', 'First Site With Isite Library ');
site.var('siteBrand', 'XSite');
<title>##var.siteName##</title>
<h2>##var.siteBrand##</h2>
<h2>Lang : ##session.lang## , Theme : ##session.theme##</h2>
//example : Read Data From User Session
<h2>query name : ##query.name## , query age : ##query.age##</h2>
//example : http://127.0.0.1?name=amr&age=33
<h2>param category : ##param.category## , param name : ##param.name##</h2>
//example : http://127.0.0.1/News/Egypt
<div x-lang="ar">Show if Site Language is Arabic</div>
<div x-lang="en">Show if Site Language is English</div>
// auto detect user session language set
<div x-permission="login">Only Login Users Can Show This Content</div>
<div x-permission="!login">Only Not Login Users Can Show This Content</div>
// auto detect user login status
<div x-feature="os.mobile">Only Users From Mobile Can Show This Content</div>
<div x-feature="os.desktop">Only Users From Mobile Can Show This Content</div>
<div x-feature="os.windows">Only Users From Windows Can Show This Content</div>
<div x-feature="os.windowsxp">Only Users From Windows XP Can Show This Content</div>
<div x-feature="os.windows7">Only Users From Windows 7 Can Show This Content</div>
<div x-feature="os.windows8">Only Users From Windows 8 Can Show This Content</div>
<div x-feature="os.windows10">Only Users From Windows 10 Can Show This Content</div>
<div x-feature="os.linux">Only Users From Linux Systems Can Show This Content</div>
<div x-feature="os.mac">Only Users From Mac Systems Can Show This Content</div>
<div x-feature="os.android">Only Users From Android Systems Can Show This Content</div>
<div x-feature="browser.edge">Only Users From Edge Browser Can Show This Content</div>
<div x-feature="browser.firefox">Only Users From FireFox Browser Can Show This Content</div>
<div x-feature="browser.chrome">Only Users From Chrome Browser Can Show This Content</div>
<div x-feature="browser.explorer">Only Users From Explorer Browser Can Show This Content</div>
<div x-feature="ip.xxx.xxx.xxx.xxx">Only Users From IP xxx.xxx.xxx.xxx Can Show This Content</div>
//auto detect user browser
- 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)
}
})
<form action="uploadFile" method="post" enctype="multipart/form-data">
<input type="file" name="fileToUpload"><br>
<input type="submit">
</form>
<form class="form">
<label>Select File To Upload</label>
<input type="file" name="fileToUpload" onchange="angular.element(this).scope().uploadFile(this.files)" />
<p>{{uploadStatus}}</p>
</form>
$scope.uploadFile = function (files) {
var fd = new FormData();
fd.append("fileToUpload", files[0]);
$http.post('/uploadFile', fd, {
withCredentials: true,
headers: {
'Content-Type': undefined
},
uploadEventHandlers: {
progress: function (e) {
$scope.uploadStatus = "Uploading : " + Math.round((e.loaded * 100 / e.total)) + " %";
if (e.loaded == e.total) {
$scope.uploadStatus = "100%";
}
}
},
transformRequest: angular.identity
}).then(function (res) {
if (res.data && res.data.done) {
$scope.uploadStatus = "File Uploaded"
}
}, function (error) {
$scope.uploadStatus = error;
});
};
site.post("uploadFile", (req, res) => {
var response = {done:true}
var file = req.files.fileToUpload
var newpath = site.dir + "/../../uploads/" + file.name
site.mv(file.path, newpath, function(err) {
if(err){
response.error = err
response.done = false
}
res.end(JSON.stringify(response))
})
})
// download any file
site.get('/files/file1.zip' , (req , res)=>{
res.download(site.dir + '/downloads/file1.zip')
})
//download and change file name
site.get('/files/file1.zip' , (req , res)=>{
res.download(site.dir + '/downloads/file1.zip' , 'info.zip')
})
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>
var app = angular.module('myApp', []);
app.controller('myController', function ($scope, $http) {
/* Register */
$scope.register = function () {
$http({
method: 'POST',
url: '/@security/api/user/register',
transformRequest: function (obj) {
var str = [];
for (var p in obj)
str.push(encodeURIComponent(p) + "=" + encodeURIComponent(obj[p]));
return str.join("&");
},
data: {
email: $scope.userEmail,
password: $scope.userPassword
},
headers: {
'Content-Type': 'application/x-www-form-urlencoded'
}
}).then(function (response) {
if (response.data.error) {
$scope.error = response.data.error;
}
if (response.data.user) {
window.location.href = '/';
}
} , function(err){
$scope.error = err;
});
};
/* Login */
$scope.login = function () {
$http({
method: 'POST',
url: '/@security/api/user/login',
transformRequest: function (obj) {
var str = [];
for (var p in obj)
str.push(encodeURIComponent(p) + "=" + encodeURIComponent(obj[p]));
return str.join("&");
},
data: {
email: $scope.userEmail,
password: $scope.userPassword
},
headers: {
'Content-Type': 'application/x-www-form-urlencoded'
}
}).then(function (response) {
if (response.data.error) {
$scope.error = response.data.error;
}
if (response.data.user) {
window.location.href = '/';
}
} , function(err){
$scope.error = err;
});
};
/* Logout */
$scope.logout = function () {
$http.post('/@security/api/user/logout').then(function (response) {
if (response.data.done) {
window.location.href = '/';
}else{
$scope.error = response.data.error;
}
}, function (error) {
$scope.error = error;
});
};
/* Cahnge Site Language */
$scope.changeLang = function(lang){
$http({
method: 'POST',
url: '/@language/change',
transformRequest: function (obj) {
var str = [];
for (var p in obj)
str.push(encodeURIComponent(p) + "=" + encodeURIComponent(obj[p]));
return str.join("&");
},
data:{ name : lang},
headers: {
'Content-Type': 'application/x-www-form-urlencoded'
}
}).then(function (response) {
if (response.data.done) {
window.location.href = window.location.href;
}
});
};
});
site.get('/' , (req , res)=>{
res.status(301) // set response code to 301 and return response object
res.set('Content-Type', 'text/plain'); // add response header
res.redirect('/URL') // Any URL
res.send('HTML CONTENT') // Any HTML Content
res.render('index') // html file name - auto parser [html and css content]
res.html('index') // like res.render
res.css('bootstrap') // css file name
res.js('jquery') // js file name
res.json(obj) // json file name or object
})
var hash = site.md5('this content will be hashed as md5')
var base64 = site.toBase64('this content will be encript as base64 string')
var normal = site.fromBase64(base64)
console.log(hash)
console.log(base64)
console.log(normal)
var name = 'absunstar'
if (name.like('*sun*')) {
console.log('yes')
}
- 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
FAQs
Create High Level Multi-Language Web Site [Fast and Easy]
The npm package isite receives a total of 29 weekly downloads. As such, isite popularity was classified as not popular.
We found that isite demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.
Security News
RubyGems.org has added a new "maintainer" role that allows for publishing new versions of gems. This new permission type is aimed at improving security for gem owners and the service overall.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.