https://github.com/seriousme/node-dash

Serverless setup using node.js
https://github.com/seriousme/node-dash

javascript nodejs serverless serverless-framework

Last synced: 3 months ago
JSON representation

Serverless setup using node.js

• Host: GitHub
• URL: https://github.com/seriousme/node-dash
• Owner: seriousme
• License: other
• Created: 2016-06-27T17:35:07.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2021-06-08T12:28:19.000Z (over 3 years ago)
• Last Synced: 2024-10-03T08:09:48.064Z (3 months ago)
• Topics: javascript, nodejs, serverless, serverless-framework
• Language: JavaScript
• Size: 971 KB
• Stars: 14
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# node-dash

[![Build Status](https://travis-ci.org/seriousme/node-dash.svg?branch=master)](https://travis-ci.org/seriousme/node-dash)

[![Greenkeeper badge](https://badges.greenkeeper.io/seriousme/node-dash.svg)](https://greenkeeper.io/)

An experiment to build a serverless setup using node.js.

![Node-dash design](https://rawgit.com/seriousme/node-dash/master/node-dash.v2.svg)

The repository and queue are implemented using [Pouchdb](https://pouchdb.com/), but

[Couchdb](http://couchdb.apache.org/) will work as well.

## Installation

There are 4 options to get this running:

- `git clone` this repository and run `npm install` followed by `npm start`

- `docker run -d -p 8080:8080 seriousme/node-dash`

- use the `docker-compose` file in the docker folder

- use `kubectl create -f https://raw.githubusercontent.com/seriousme/node-dash/master/k8/node-dash.yaml` to create a deployment on a [Kubernetes](https://kubernetes.io/) Installation.

Once it runs you can send your browser to http://\:8080/ which will show you a web interface, on Kubernetes `kubectl describe service apiserver` will show the IP/port.

Alternatively you can use any REST client (e.g. CURL/Postman/etc) to talk to the API server

## REST endpoints

The following endpoints are supported:

### List of requests:

```

curl -X GET "http://localhost:8080/dash/requests"

```

### Details of a request

```

curl -X GET "http://localhost:8080/dash/requests/:requestid"

```

### Create a new asynchronous request

An example:

```

curl -X GET "http://localhost:8080/myactions/sum?a=1&b=2"

```

### Create a new synchronous request

An example:

```

curl -X GET "http://localhost:8080/myactions/sum?a=1&b=2&sync"

```

### List of actions

```

curl -X GET "http://localhost:8080/dash/actions"

```

### Details of an action

```

curl -X GET "http://localhost:8080/dash/actions/:actionid"

```

### Create a new action

An example:

```

curl -X PUT -H "Content-Type: application/json" -d '{

  "_id": "/myactions/min",

  "code": "function main(params){ return { \"min\": Number(params.a) - Number(params.b)};}"

}' "http://localhost:8080/dash/actions/%2fmyactions%2fmin"

```

### Update an action

An example:

```

curl -X PUT -H "Content-Type: application/json" -d '{

  "_id": "/myactions/min",

  "code": "function main(params){ return { \"min\": Number(params.a) - Number(params.b)};}",

  "_rev": "1-dadb9a995a83675dea6954a1515e08bb"

}' "http://localhost:8080/dash/actions/%2fmyactions%2fmin"

```

## Todo

Its an experiment, so don't use this in production unless you know what you are doing !

E.g. isolation between actioncode and the framework is based on node VM functionality

which offers some protection but is not bulletproof against hostile actions !

A better, and more elaborate, approach would be to inject the action code into a docker

container and then send the requests to that container. If the container is then idle for

say 5 minutes it can be shut.