Skip to content

Atlantis-Software/synapps

Repository files navigation

synapps

synapps is a web framework for Node.js

npm version Linux Build Windows Build Coverage Status Dependencies Status

var synapps = require('@synapps/core');
var app = synapps();

app.route('/', function(req) {
  req.resolve('hello world');
});

app.listen(3000);
$ curl http://127.0.0.1:3000
hello world

Installation

This is a Node.js module available through the npm registry.

Before installing, download and install Node.js. Node.js 6 or higher is required.

Installation is done using the npm install command:

$ npm install @synapps/core

Docs

Visit the Wiki

Examples

To view the examples, clone the Synapps repo and install the dependencies:

$ git clone git://github.com/Atlantis-Software/synapps.git
$ cd synapps/
$ npm install

Then install the dependencies and run whichever example you want:

$ cd examples/auth
$ npm install
$ node index

Tests

To run the test suite, first install the dependencies, generate ssl key, then run npm test:

$ git clone git://github.com/Atlantis-Software/synapps.git
$ cd synapps/
$ npm install
$ npm test

License

MIT