Merge pull request #574 from Runnable/master

Provide a link to a live sandbox environment where sequelizse examples are available

README.md

@@ -30,7 +30,7 @@ The Sequelize library provides easy access to MySQL, SQLite or PostgreSQL databa
 - Associations
 - Associations
 - Importing definitions from single files
 - Importing definitions from single files
 
 
-## Documentation, Examples and Updates ##
+## Documentation and Updates ##
 
 
 You can find the documentation and announcements of updates on the [project's website](http://www.sequelizejs.com).
 You can find the documentation and announcements of updates on the [project's website](http://www.sequelizejs.com).
 If you want to know about latest development and releases, follow me on [Twitter](http://twitter.com/sdepold).
 If you want to know about latest development and releases, follow me on [Twitter](http://twitter.com/sdepold).
@@ -42,6 +42,11 @@ Also make sure to take a look at the examples in the repository. The website wil
 - [Google Groups](https://groups.google.com/forum/#!forum/sequelize)
 - [Google Groups](https://groups.google.com/forum/#!forum/sequelize)
 - [XING](https://www.xing.com/net/priec1b5cx/sequelize) (pretty much inactive, but you might want to name it on your profile)
 - [XING](https://www.xing.com/net/priec1b5cx/sequelize) (pretty much inactive, but you might want to name it on your profile)
 
 
+## Running Examples
+Instructions for running samples are located in the [example directory](https://github.com/sequelize/sequelize/tree/master/examples). Try these samples in a live sandbox environment:
+
+<a href="https://runnable.com/sequelize" target="_blank"><img src="https://runnable.com/external/styles/assets/runnablebtn.png"></a>
+
 ## Roadmap
 ## Roadmap
 
 
 A very basic roadmap. Chances aren't too bad, that not mentioned things are implemented as well. Don't panic :)
 A very basic roadmap. Chances aren't too bad, that not mentioned things are implemented as well. Don't panic :)

examples/Associations/app.js

@@ -9,7 +9,7 @@
 */
 */
 
 
 var Sequelize = require(__dirname + "/../../index")
 var Sequelize = require(__dirname + "/../../index")
-  , config    = require(__dirname + "/../../test/config")
+  , config    = require(__dirname + "/../../spec/config/config")
   , sequelize = new Sequelize(config.database, config.username, config.password, {logging: false})
   , sequelize = new Sequelize(config.database, config.username, config.password, {logging: false})
   , Person    = sequelize.define('Person', { name: Sequelize.STRING })
   , Person    = sequelize.define('Person', { name: Sequelize.STRING })
   , Pet       = sequelize.define('Pet',    { name: Sequelize.STRING })
   , Pet       = sequelize.define('Pet',    { name: Sequelize.STRING })

examples/Count/app.js

 var Sequelize = require(__dirname + "/../../index")
 var Sequelize = require(__dirname + "/../../index")
-  , config    = require(__dirname + "/../../test/config")
+  , config    = require(__dirname + "/../../spec/config/config")
   , sequelize = new Sequelize(config.database, config.username, config.password, {logging: false})
   , sequelize = new Sequelize(config.database, config.username, config.password, {logging: false})
 
 
 var Person  = sequelize.define('Person', { name: Sequelize.STRING })
 var Person  = sequelize.define('Person', { name: Sequelize.STRING })

examples/MinMax/app.js

 var Sequelize = require(__dirname + "/../../index")
 var Sequelize = require(__dirname + "/../../index")
-  , config    = require(__dirname + "/../../test/config")
+  , config    = require(__dirname + "/../../spec/config/config")
   , sequelize = new Sequelize(config.database, config.username, config.password, {logging: false})
   , sequelize = new Sequelize(config.database, config.username, config.password, {logging: false})
 
 
 var Person  = sequelize.define('Person',
 var Person  = sequelize.define('Person',

examples/Performance/app.js

 var Sequelize    = require(__dirname + "/../../index")
 var Sequelize    = require(__dirname + "/../../index")
-  , config       = require("../../test/config")
+  , config    = require(__dirname + "/../../spec/config/config")
   , sequelize    = new Sequelize(config.database, config.username, config.password, {logging: false, host: config.host})
   , sequelize    = new Sequelize(config.database, config.username, config.password, {logging: false, host: config.host})
   , QueryChainer = Sequelize.Utils.QueryChainer
   , QueryChainer = Sequelize.Utils.QueryChainer
   , sys          = require("sys")
   , sys          = require("sys")

examples/image-handling/app.js

-var fs        = require("fs")
-  , Sequelize = require("sequelize")
-  , sequelize = new Sequelize('sequelize_test', 'root', null, {logging: false})
-  , Image     = sequelize.define('Image', { data: Sequelize.TEXT })
+/*
+  Title: Default values
 
 
-Image.sync({force: true}).on('success', function() {
-  console.log("reading image")
-  var image = fs.readFileSync(__dirname + '/source.png').toString("base64")
-  console.log("done\n")
+  This example demonstrates the use of default values for defined model fields. Instead of just specifying the datatype,
+  you have to pass a hash with a type and a default. You also might want to specify either an attribute can be null or not!
+*/
 
 
-  console.log("creating database entry")
-  Image.create({data: image}).on('success', function(img) {
-    console.log("done\n")
+var Sequelize = require(__dirname + "/../../index")
+  , config    = require(__dirname + "/../../spec/config/config")
+  , sequelize = new Sequelize(config.database, config.username, config.password, {logging: false})
 
 
-    console.log("writing file")
-    fs.writeFileSync(__dirname + '/target.png', img.data, "base64")
-    console.log("done\n")
+var User = sequelize.define('User', {
+      name: { type: Sequelize.STRING, allowNull: false},
+      isAdmin: { type: Sequelize.BOOLEAN, allowNull: false, defaultValue: false }
+    })
+  , user = User.build({ name: 'Someone' })
+
+sequelize.sync({force: true}).on('success', function() {
+  user.save().on('success', function(user) {
+    console.log("user.isAdmin should be the default value (false): ", user.isAdmin)
 
 
-    console.log("you might open the file ./target.png")
+    user.updateAttributes({ isAdmin: true }).on('success', function(user) {
+      console.log("user.isAdmin was overwritten to true: " + user.isAdmin)
+    })
   })
   })
+}).on('failure', function(err) {
+  console.log(err)
 })
 })
\ No newline at end of file

examples/method-passing/app.js

@@ -5,7 +5,7 @@
 */
 */
 
 
 var Sequelize = require(__dirname + "/../../index")
 var Sequelize = require(__dirname + "/../../index")
-  , config    = require(__dirname + "/../../test/config")
+  , config    = require(__dirname + "/../../spec/config/config")
   , sequelize = new Sequelize(config.database, config.username, config.password, {logging: false})
   , sequelize = new Sequelize(config.database, config.username, config.password, {logging: false})
 
 
 // model definition
 // model definition

examples/sequelize-with-options/app.js

 var Sequelize = require(__dirname + "/../../index")
 var Sequelize = require(__dirname + "/../../index")
-  , config    = require(__dirname + "/../../test/config")
+  , config    = require(__dirname + "/../../spec/config/config")
   , sequelize = new Sequelize(config.database, config.username, config.password, {
   , sequelize = new Sequelize(config.database, config.username, config.password, {
       // use other database server or port
       // use other database server or port
       host: 'my.srv.tld',
       host: 'my.srv.tld',

examples/using-multiple-model-files/app.js

 var Sequelize = require(__dirname + "/../../index")
 var Sequelize = require(__dirname + "/../../index")
-  , config    = require(__dirname + "/../../test/config")
+  , config    = require(__dirname + "/../../spec/config/config")
   , sequelize = new Sequelize(config.database, config.username, config.password, {logging: false})
   , sequelize = new Sequelize(config.database, config.username, config.password, {logging: false})
   , Project   = sequelize.import(__dirname + "/Project")
   , Project   = sequelize.import(__dirname + "/Project")
   , Task      = sequelize.import(__dirname + "/Task")
   , Task      = sequelize.import(__dirname + "/Task")