Repository files navigation

• About Keystone
• Getting Started
• Community
• Contributing
• License

KeystoneJS is a powerful Node.js content management system and web app framework built on theExpress web framework andMongoose ODM. Keystone makes it easy to create sophisticated web sites and apps, and comes with a beautiful auto-generated Admin UI.

Check out ourdemo site to see it in action.

For Keystone v4 documentation and guides, seekeystonejs.com.

For Keystone v0.3 documentation, seev3.keystonejs.com.

This section provides a short intro to Keystone. Check out theGetting Started Guide in the Keystone documentation for a more comprehensive introduction.

The easiest way to get started with Keystone is to use the Yeoman generator:

$ npm install -g generator-keystone$ yo keystone

Answer the questions, and the generator will create a new project based on the options you select, and install the required packages fromnpm.

Alternatively, to include Keystone in an existing project or start from scratch (without Yeoman), specifykeystone: "4.0.0" in thedependencies array of yourpackage.json file, and runnpm install from your terminal.

Then read through theDocumentation and theExample Projects to understand how to use it.

Config variables can be passed in an object to thekeystone.init method, or can be set any time beforekeystone.start is called usingkeystone.set(key, value). This allows for a more flexible order of execution. For example, if you refer to Lists in your routes you can set the routes after configuring your Lists.

See theKeystoneJS configuration documentation for details and examples of the available options.

Keystone builds on the basic data types provided by MongoDB and allows you to easily add rich, functional fields to your application's models.

You get helper methods on your models for dealing with each field type easily (such as formatting a date or number, resizing an image, getting an array of the available options for a select field, or using Google's Places API to improve addresses) as well as a beautiful, responsive admin UI to edit your data with.

See theKeystoneJS database documentation for details and examples of the various field types, as well as how to set up and use database models in your application.

When you deploy your KeystoneJS app to production, be sure to set yourENV environment variable toproduction.

You can do this by settingNODE_ENV=production in your.env file, which gets handled bydotenv.

Setting your environment enables certain features (including template caching, simpler error reporting, and HTML minification) that are important in production but annoying in development.

We have a friendly, growing community and welcome everyone to get involved:

• Follow@KeystoneJS on twitter for news and announcements.
• Ask technical questions onStack Overflow and tag themkeystonejs.
• Report bugs and feature suggestions on our GitHubissue tracker.
• Join theKeystoneJS Slack for general discussion with the Keystone community and contributors.

We love to hear feedback about Keystone and the projects you're using it for. Ping us at@KeystoneJS on Twitter.

If you can, please contribute by reporting issues, discussing ideas, helping answer questions from other developers, or submitting pull requests with patches and new features. We do our best to respond to all issues and pull requests, and make patch releases to npm regularly.

If you're going to contribute code, please follow ourcoding standards and read ourContributing Guide.

If you are using KeystoneJS in any projects we encourage you to add to ourRelated Projects Page. This is also the place to find generators and other projects that bundle KeystoneJS.

KeystoneJS is a free and open source community-driven project. Thanks to our manycontributors andusers for making it great.

Keystone's development has been led by key contributors includingJed Watson,Joss Mackison, andMax Stoiber and is proudly supported byThinkmill in Sydney, Australia.

(The MIT License)

Copyright (c) 2016-2019 Jed Watson

Permission is hereby granted, free of charge, to any person obtaininga copy of this software and associated documentation files (the'Software'), to deal in the Software without restriction, includingwithout limitation the rights to use, copy, modify, merge, publish,distribute, sublicense, and/or sell copies of the Software, and topermit persons to whom the Software is furnished to do so, subject tothe following conditions:

The above copyright notice and this permission notice shall beincluded in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANYCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THESOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.