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

@modernistik/hyperdrive

0.2.6 • Public • Published

Modernistik Hyperdrive

Modern application server for building mobile and cloud applications quickly at scale in a service oriented architecture (SOA/Microservices). Hyperdrive is composed of the Parse Platform server with additional features that allow for best practice deployments. The default configuration allows for easy deployment using Heroku or Amazon Web Services (AWS).

The additional features include:

  • Both MongoDB and PostgreSQL supported as database adapters.
  • AWS S3, Google Cloud Storage or MongoDB GridFS for file storage.
  • Routing of incoming webhooks into cloud functions.
  • Support for Mailgun and AWS Simple Email Service (SES) email adapters.
  • Push Notifications through Amazon SNS for both iOS and Android.
  • Built-in Parse Dashboard
  • Simplified microservice configuration with available ENV API.

Getting Started

To quickly get started with Hyperdrive, you will first need to install it from the NPM repository.

$ npm install -g @modernistik/hyperdrive

If you need to install a quick MongoDB database, you can do so with mongodb-runner.

# Install mongodb and start the database service 
$ npm install -g mongodb-runner
 
# Start MongoDB localhost:27017 
$ mongodb-runner start

Once installed and a database is running, you can then start a default Hyperdrive instance:

# start instance using MongoDB localhost:27017 
# see `hyperdrive -h` for usage 
$ hyperdrive -s

After the server has started successfully, the API server will be available at http://localhost:1337/parse, and you should be able to access the built-in dashboard at the url http://localhost:1337/dashboard. If you have any connection errors, make sure the database server is available and you can connect to it.

By default, if no AWS S3 configuration is provided, Hyperdrive will store files directly in the database.

Hyperdrive can mostly be configured by setting environment variables which combine specific Hyperdrive variables with the ones used by Parse Server. To see a list of variables used by Hyperdrive use the -h option or the --info <optName> to get details.

# Get help 
$ hyperdrive -h
 
# Get info on a specific configuration 
$ hyperdrive --info databaseURI
# databaseURI : DATABASE_URI 
# 
#   The database url for either MongoDB or PostgreSQL. 

Copyright and License

Copyright (C) 2013 Modernistik LLC (https://www.modernistik.com). Requires agreement for commercial use.

Keywords

none

install

npm i @modernistik/hyperdrive

Downloadsweekly downloads

0

version

0.2.6

license

SEE LICENSE IN LICENSE

repository

githubgithub

last publish

collaborators

  • avatar