A functional framework for composing Node applications
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.vscode
example
src
tests
tools
.coveralls.yml
.gitignore
.npmignore
.travis.yml
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE
README.md
index.js
mocha.opts
package.json
yarn.lock

README.md

Build Status Coverage Status npm version Chat at https://gitter.im/funcatron-funcatron/core

Funcatron

A functional framework for composing Node applications

Documentation

See Full API Documentation (in progress).

Installation

npm install funcatron --save or yarn add funcatron

Usage

const { funcatron } = require("funcatron")

// Pass funcatron an array of route definitions
funcatron([
    {
        path: "/",
        method: "get",
        handler: ({req, res}) => res.end("Hello World! yours sincerely, funcatron")
    },
    {
        path: "/login",
        method: "post",
        handler: ({req, res}) => res.end("Post request received")
    }
]).listen(8000)

Contributing

Contributions welcome on Github. All core-API changes should also be accompanied by a change-request to the documentation.

Before making a contribution, please review the Code of Conduct.

If you're new to Open Source, I'd love if Funcatron was your first project that you contribute to. Check-out the Contributing document for how to get started.

Issues

Issues gladly accepted on Github.