Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    scalrapublic

    (master) Build Status - master Build Status - dev (dev)

    Scalra

    node framework to prototype and scale API servers rapidly.

    require('scalra')('curr');
     
    SR.API.add('HelloWorld', {
        name: 'string'
    }, function (args, onDone) {
        LOG.warn('HelloWorld called with: ' + args);
        onDone(null, {hello: args.name});
    });
     
    var l_frontier = new SR.Frontier(37070);
    l_frontier.init();

    Then called at server:

    SR.API.HelloWorld({name: 'John'}, function (err, result) {
        LOG.debug('positive test result: ');
        if (err) {
            return LOG.error(err);
        }
        LOG.warn(result);
    });

    Or at clients:

    <html><head>
    <script type="text/javascript" src="/lib/scalra.js"></script>
    <script>
     
    var onConnect = function () {
     
        SR.API.HelloWorld({name: 'world'}, function (err, result) {
            if (err) {
                return alert(err);
            }
            document.write('Hello: ' + result.hello);
            console.log(result);
        }); 
    }
     
    </script> 
    </head></html>

    Or request from URL:

    http://127.0.0.1:37070/event/HelloWorld?name=world
    

    Installation

    $ npm install scalra

    see Installation Guide for full instructions to setup a Scalra system on empty systems.

    Features

    • Write one API logic for any connection types (HTTP/HTTPS/websocket/socket)
    • Logic is called in the same style at both client and server
    • Shared sessions between HTTP and WebSocket requests
    • Publish / subscribe (pub/sub) as messaging layer
    • Auto-reload of modified logic scripts
    • Works out-of-box with MongoDB and Express
    • In-memory DataStore that access and update DB data simply as variables

    see Release Notes on various changes / new features in each releases.

    Docs & Community

    Quick Start

    Simply copy the demo project under /demo as your own project

    $ npm install scalra
    $ cp -R node_modules/scalra/demo /tmp/foo && cd /tmp/foo

    Install dependencies:

    $ npm install scalra

    Start the server:

    $ npm start

    Verify server is up with:

    http://127.0.0.1:37070/event/HelloWorld?name=world
    

    Philosophy

    Scalra is designed to allow server developers to focus on logic development instead of networking or server management issues. Once developed using the Scalra framework, the server's reliability, security, and scalability is automatically covered without having to worry about re-writing code when the service is under heavy workload.

    Additional functionalities can be added with pluggable Scalra modules.

    People

    Scalra is created by Imonology Inc. [github]

    License

    AGPL-3.0

    install

    npm i scalra

    Downloadsweekly downloads

    127

    version

    1.8.27

    license

    AGPL-3.0

    repository

    githubgithub

    last publish

    collaborators

    • avatar