npm

Need private packages and team management tools?Check out npm Orgs. »

spawnpoint

1.0.6 • Public • Published

Spawnpoint Logo npm version dependencies Status Build Status Coverage Status FOSSA Status

Spawnpoint

Agnostic JS framework that empowers devs to focus on quickly building apps, rather than focusing on application config, health-checks, application structure, or architecture to build a 12 factor app in Docker.

Quickstart

This quick demo shows that you can create a basic API in just a couple files that's defined by configuration, but is 12 factor ready, Docker ready, and much more! Check out the full demo here.

npm install spawnpoint --save

// ~/app.js
const spawnpoint = require('spawnpoint');
 
const app = new spawnpoint();
app.setup();
// ~/config/app.json
{
    "name": "Example App",
    "plugins": [
        "spawnpoint-express", // this creates an express server
        "spawnpoint-redis" // this establishes a connection to a redis server via redisio
    ],
    "autoload": [
        // this autoloads all js files in the ~/controllers folder
        {
            "name": "Controllers",
            "folder": "controllers"
        }
    ]
}
// ~/controllers/app.js
module.exports = (app) => {
    // express is already setup and configured via JSON
    app.server.get('/user/:id', (req, res) => {
        // redis is already connected and ready
        app.redis.get(`user:${req.params.id}`, (err, results) => {
            if(err){ res.fail(err); } // automatic error handling
 
            // return JSON formated success with a success code
            res.success('users.list', {
                user: JSON.parse(results)
            });
        });
    });
};

Plugins

Spawnpoint plugins create opinionated & re-usable components that reduce the code needed to kickstart projects. Plugins are configured via JSON config files, making them easier to share between projects with different needs.

Another JS Framework? Why?

We constantly found our dev team rebuilding the same components to our micro services that make up the Multiplayer Gaming Cloud platform at Nodecraft. Most of the features had blatant copy/paste to ensure our applications could:

  • Building 12 factor apps
  • Auto-loading multiple folders for product folder structure
  • File require() recursion management overhead ?
  • Support basic --command="args" that override config files
  • ENV variables that override config files
  • Docker Secrets that override config files
  • Dev config overrides
  • Rebuilding a basic JSON REST API via express
  • Database connect/reconnect management
  • Healthchecks
  • Application lifecycle
    • Tracks app startup
    • Graceful shutdown
  • Making a Docker friendly NodeJS app

Hoisting app

The most opinionated design choice that Spawnpoint makes is hoisting the entire framework runtime into each file. You can name this variable anything, but the best practice is to name this variable app. All system models, libraries, and config are hoisted to this variable with several namespaces:

app.config

All application config is mounted here. For example app.config.express is where all configuration is available to the spawnpoint-express plugin.

app.status

Tracks the current application lifecycle.

app.containerized

Detects if app is running in a container.

app.cwd

Returns the main folder where your application lives.

Hoisting your own Libraries

When you hoist your library on the app variable you can access it on any other autoloaded js file.

module.exports = (app) => {
    app.yourLibName = {
        add(a, b){
            return a + b;
        }
    };
}
app.server.post('/add', (req, res) => {
    // redis is already connected and ready
    let results = app.yourLibName.add(req.body.a, req.body.b);
    res.success('math.add', {
        results: results
    });
});
 

Framework Examples

Documentation

Get the full API Docs here.

License

FOSSA Status

install

npm i spawnpoint

Downloadsweekly downloads

148

version

1.0.6

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
  • avatar
Report a vulnerability