KeystoneJS (Node.js CMS & Web Application Platform)

|--lib
| Custom libraries and other code
|--models
| Your application's database models
|--public
| Static files (css, js, images, etc.) that are publicly available
|--routes
| |--api
| | Your application's api controllers
| |--views
| | Your application's view controllers
| |--index.js
| | Initialises your application's routes and views
| |--middleware.js
| | Custom middleware for your routes
|--templates
| |--includes
| | Common .jade includes go in here
| |--layouts
| | Base .jade layouts go in here
| |--mixins
| | Common .jade mixins go in here
| |--views
| | Your application's view templates
|--updates
| Data population and migration scripts
|--package.json
| Project configuration for npm
|--web.js
| Main script that starts your application

Models

Before you can start your Keystone app, you’ll need some data models. We’re going to start with the User model, which is special – we need it so that Keystone can do authentication and session management. Create the following two files in the /models folder models/index.js

require('./users.js');

models/users.js

var keystone = require('keystone'),
 Types = keystone.Field.Types;
var User = new keystone.List('User');
User.add({
 name: { type: Types.Name, required: true, index: true },
 email: { type: Types.Email, initial: true, required: true, index: true },
 password: { type: Types.Password, initial: true },
 canAccessKeystone: { type: Boolean, initial: true }
});
User.register();

Authentication and Session Management

For Keystone to provide authentication and session management to your application, it needs to know a few things (which we’ve now configured).

• The option user model must be the name of the Model that Keystone should look in to find your users. If you use a different model name, be sure to set the option correctly.
• If you want your application to support session management, set the session option to true. Loading sessions incurs a small overhead, so if your application doesn’t need sessions you can turn this off.
• Keystone has built-in views for signing in and out. To enable them, set the auth option to true. You can also implement custom signin and signout screens in your applications’ views.
• Sessions are persisted using an encrypted cookie storing the user’s ID. Make sure you set the cookie secret option to a long, random string.
• The user model must have a canAccessKeystone property (which can be a virtual method or a stored boolean) that says whether a user can access Keystone’s Admin UI or not. *Note* If you choose to use a virtual method setting the value in mongodb directly will not authenticate correctly. A virtual method is useful when the criteria for access is more complex. See Mongoose virtuals

Routes

var keystone = require('keystone');
exports = module.exports = function(req, res) {
 var view = new keystone.View(req, res);
 view.render('index');
}

extends ../layouts/base
block content
 h1 Hello World

1 exports.create={
2 User:[
3 {'name.first':'Admin','name.last':'User',email:'user@keystonejs.com',
4 password:'admin',isAdmin:true}
5 ]
6 };