deployd

deployd

the simplest way to build an api.

overview

Deployd is the simplest way to build realtime APIs for web and mobile apps. Ready-made, configurable Resources add common functionality to a Deployd backend, which can be further customized with JavaScript Events.

Read more about deployd

⚠️ Deployd v1.0.0 has been released. Read the migration guide below.

quick start

$ dpd create hello
$ cd hello
$ dpd -d

helpful resources

• Docs
• Getting Started Guide
• Hello World Tutorial
• API Docs
• Community Discussion Page
• Gitter Chat Page
• Example Apps

requirements

Deployd is built using node and published using npm.
To install and use it, you need to install Node.JS.

Migration guide to v1.0.0

v1.0.0 contains a big refactoring: the CLI, dashboard and client-lib has been extracted from the core to allow easier contributions and maintainability.
Here's a guide to help you migrate to v.1.0.0.

If you start your application using a node script (recommend), you just need to update the deployd dependency and add the missing ones (client-lib and dashboard).

$ npm update deployd
$ npm install dpd-dashboard dpd-clientlib

If you use the CLI to start your app (using dpd inside your app folder), you will need to uninstall it and reinstall deployd-cli. npm uninstall deployd -g && npm install deployd-cli -g

If you have troubles making it work, feel free to ask for help on the chat.

install from npm

Once Node.JS is installed, open your terminal and type the following command:

npm install deployd-cli -g

the dpd command should be available. Type dpd -V and the current version should appear.

install on windows

The windows installer is deprecated. The recommended way is now npm (npm install deployd-cli -g) and install mongodb separately.

install on macosx

The macosx installer is deprecated. The recommended way is now npm (npm install deployd-cli -g) and install mongodb separately.

install from source

git clone https://github.com/deployd/deployd.git
npm install

unit & integration tests

cd deployd
mongod &
npm test

license

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Copyright 2017 deployd llc

Changelog

v1.0.0 (2017-09-19)

Bug Fixes

• collection: protect and hide should not modify this (#782) (a9fdc4cf)
• internal-client: add req.resume() (#785) (5e2c7813)
• add socketIo check (#802) (ce04ddee)
• fix: server.attach() did not enable socket clustering (#777) (04bb24a2)

Breaking Changes ⚠️

• refactor: remove dpd cli from deployd core module (#776) (626d4ad6)

• refactor(*): remove dashboard and clientlib from deployd core module (#783) (c9d0a91d)

  ℹ️ A migration guide is available in the readme

<a name="v0.8.10"></a>