bootjs

1.0.1 • Public • Published

GitHub license

A lightweight web framework based on Node.js and Express.js

bootjs logo

Intallation.

cnpm install express

cnpm install bootjs

Or you can create a package.json as below:

{
  "name": "hello",
  "version": "1.0.0",
  "description": "minimal web project based on bootjs ",
  "main": "app.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "Allen Guo",
  "license": "MIT",
  "dependencies": {
    "bootjs": "^0.1.10",
    "express": "^4.14.1"
  }
}

then run

cnpm i

Quickstart.

Step 1: Create a project

Below is a minimal bootjs web application. Suppose we have a project named 'hello', here is the project folder layout:

[app]
  |_config.js # configuration file.
  |_[src] 
  |   |_ [controllers]
  |         |_ IndexController.js
app.js # bootstrap file.
package.json

Step 2: Edit config.js

'use strict';
module.exports = {
    baseDir: __dirname + '/app/src/' // Mandatory item.
}

Step 3: Edit app.js

'use strict';

const express = require('express');
const app = express();
const Bootjs = require('bootjs');
const config = require('./config.js');

const bootjs = Bootjs(app, config);

// initialize bootjs.
bootjs.init();

// add routes to bootjs.
bootjs.addRoutes(); 

app.listen(5000, () => {
    console.log('A http server started at localhost:5000.');
}); 

Step 4: Write a sample.

Create IndexController.js under app/src/ as below:

'use strict';
module.exports = class {
    index() {
        this.res.end('Hello Bootjs');
    }
}

Start bootjs server and access it.

Enter project folder then run

node app.js

Go to browser and enter http://localhost:5000, you will got a page which say 'Hello Bootjs'.

MIT

Readme

Keywords

Package Sidebar

Install

npm i bootjs

Weekly Downloads

0

Version

1.0.1

License

MIT

Last publish

Collaborators

  • guozhaoyu