Giter Club home page Giter Club logo

dynamoose's Introduction

Dynamoose

Join the chat at https://gitter.im/dynamoosejs/Lobby Build Status Coverage Status

Dynamoose is a modeling tool for Amazon's DynamoDB (inspired by Mongoose)

Getting Started

Installation

$ npm install dynamoose

Example

Set AWS configurations in enviroment varable:

export AWS_ACCESS_KEY_ID="Your AWS Access Key ID"
export AWS_SECRET_ACCESS_KEY="Your AWS Secret Access Key"
export AWS_REGION="us-east-1"

Here's a simple example:

var dynamoose = require('dynamoose');

// Create cat model with default options
var Cat = dynamoose.model('Cat', { id: Number, name: String });

// Create a new cat object
var garfield = new Cat({id: 666, name: 'Garfield'});

// Save to DynamoDB
garfield.save();

// Lookup in DynamoDB
Cat.get(666)
.then(function (badCat) {
  console.log('Never trust a smiling cat. - ' + badCat.name);
});

API Docs

The documentation can be found at https://dynamoosejs.com/api. You can also find additional examples at https://dynamoosejs.com/examples.

Help Wanted!

Help improve Dynamoose. I need all the help I can get to improve test coverage and the documentation. If you would like to help please look at the /test folder to add tests to the project along with /docs/_docs and /docs/_examples folders to help write better documentation and examples for Dynamoose. You can create a PR (pull request) to get your changes merged in. Thank you very much!!

ChangeLog

The Dynamoose ChangeLog can be found in the CHANGELOG.md file.

Roadmap

The Dynamoose Roadmap can be found in the ROADMAP.md file. Help is always appreciated on these items. If you are able to help submit a PR so we can review and improve Dynamoose!

dynamoose's People

Contributors

fishcharlie avatar brandongoode avatar jutaz avatar khamasaki avatar aloof-ruf avatar joshuadutton avatar dolsem avatar devotox avatar jottinger avatar nealshail avatar ricardopinto avatar i1skn avatar mooyoul avatar mogwai avatar darthapple avatar lucianopf avatar strygin avatar cbarrese avatar jonathonlui avatar hassankhan avatar billouboq avatar sgtoj avatar danielboa avatar piercus avatar ro-savage avatar peecky avatar troyswanson avatar stang-tgs avatar koladilip avatar dropdevcoding avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.