@gamechange/spur-web
Advanced tools
Common node modules and express middleware that are designed to be the boilerplate of a node web app.
Common node modules and express middleware that are designed to be the boilerplate of a node web app.
The Spur Framework is a collection of commonly used Node.JS libraries used to create common application types with shared libraries.
Visit NPMJS.org for a full list of Spur Framework libraries >>
Dependencies:
$ npm install --save spur-ioc spur-common spur-config
Module:
$ npm install --save spur-web
Note: The example code below expects that you are using Node 6. We follow the active Node LTS schedule.
src/config/*For an example of the configuration, please take a look at this example: example/src/config/.
src/injector.jsconst path = require('path');
const spur = require('spur-ioc');
const spurCommon = require('spur-common');
const registerConfig = require('spur-common/registerConfig');
const spurWeb = require('spur-web');
module.exports = function () {
const ioc = spur.create('example');
// Register configuration
registerConfig(ioc, path.join(__dirname, './config'));
ioc.merge(spurCommon());
ioc.merge(spurWeb());
// register folders in your project to be auto-injected
ioc.registerFolders(__dirname, [
'controllers/',
'runtime/'
]);
return ioc;
};
src/runtime/WebServer.jsmodule.exports = function (BaseWebServer, path) {
class WebServer extends BaseWebServer {
// Add additional changes to the middleware by overriding the method
registerDefaultMiddleware() {
super.registerDefaultMiddleware();
this.registerEjsTemplates();
}
registerEjsTemplates() {
this.logSectionHeader('EJS Template Registration');
this.app.set('view engine', 'ejs');
this.app.set('views', path.join(__dirname, '../views'));
}
}
// Assure there is just one instance
return new WebServer();
};
src/views/hello.ejs<html>
<head>
<meta charset="utf-8">
</head>
<body>
<h1><%= user %></h1>
</body>
</html>
src/controllers/HelloController.jsFiles ending in *Controller.js are auto registered as controllers.
module.exports = function (BaseController) {
class HelloController extends BaseController {
configure(app) {
super.configure(app);
app.get('/', this.getRoot.bind(this));
app.get('/hello', this.getHello.bind(this));
}
getRoot(req, res) {
res.status(200).send('This is the root page defined in HelloController.js.');
}
getHello(req, res) {
const model = {
user: req.query.user || 'John Doe'
};
res.render('hello', model);
}
}
return new HelloController();
};
start.jsconst injector = require('./src/injector');
// IMPORTANT: The callback needs to be a function call vs. using a fat-arrow block. Fat-arrow is not supported yet.
injector().inject(function (UncaughtHandler, WebServer, Logger, config, configLoader, nodeProcess) {
UncaughtHandler.listen();
Logger.info(`NODE_ENV: ${nodeProcess.env.NODE_ENV}`);
Logger.info(`PORT: ${config.Port}`);
Logger.info(`CONFIG: ${configLoader.configName}`);
WebServer.start()
.then(() => {
// Execute other logic after the server has started
});
});
$ npm start
To see the latest list of the default dependencies that are injected, check out the injector.js file. Here is a short list of of all of the dependencies available:
List of external dependencies used and exposed by spur-web. They can be found at npmjs.org using their original names.
| Name | Original Module Name |
|---|---|
| express | express |
| methodOverride | method-override |
| cookieParser | cookie-parser |
| bodyParser | body-parser |
| expressWinston | express-winston |
| ejs | ejs |
All of the files under the src/ directory are made available when this module is merged into another injector. The following list are the notable dependencies available.
| Name | Source | Description |
|---|---|---|
| BaseController | code | A base class in order to be able to identify all of the controllers derived from it. |
| BaseWebServer | code | A base web server that sets all of the middleware mentioned here. |
| ControllerRegistration | code | Registers all of the controllers based on the BaseController type and also files that end with Controller |
| BaseMiddleware | code | A base class in order to be able to identify all of the middleware derived from it. |
| Name | Source | Description |
|---|---|---|
| HtmlErrorRender | code | Sets basic error rendering for uncaught errors. |
| DefaultMiddleware | code | Registers default express middleware: cookie parser, body parser, method override, and express device |
| ErrorMiddleware | code | Adds error handling for unhandled errors for requests. |
| NoCacheMiddleware | code | Middleware for no cache headers |
| PromiseMiddleware | code | Extends the response object with functionality to be used through promises. It unwraps promises as they are being resolved. |
| WinstonRequestLoggingMiddleware | code | Winston middleware for logging every request to the console log. |
Please send in pull requests and they will be reviewed in a timely manner. Please review this generic guide to submitting a good pull requests. The only things we ask in addition are the following:
The majority of the settings are controlled using an EditorConfig configuration file. To use it please download a plugin for your editor of choice.
To run the test suite, first install the dependancies, then run npm test
$ npm install
$ npm test
FAQs
Common node modules and express middleware that are designed to be the boilerplate of a node web app.
The npm package @gamechange/spur-web receives a total of 0 weekly downloads. As such, @gamechange/spur-web popularity was classified as not popular.
We found that @gamechange/spur-web demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 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
Newly introduced telemetry in devenv 1.4 sparked a backlash over privacy concerns, leading to the removal of its AI-powered feature after strong community pushback.
Security News
TC39 met in Seattle and advanced 9 JavaScript proposals, including three to Stage 4, introducing new features and enhancements for a future ECMAScript release.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.