Skip to content

Commit

Permalink
Fix #4708: Update Getting Started page
Browse files Browse the repository at this point in the history
  • Loading branch information
stennie committed Jul 12, 2018
1 parent 637aa68 commit e26ad60
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions docs/Getting Started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,29 @@

## What is Keystone?

Keystone is a CMS and web application framework built in node. It aims to make web development easy, with lots of work done for you, but without cutting down on how much you can customise your projects, allowing you to find the right balance for you between convention and customisation.
Keystone is a powerful Node.js content management system and web app framework built on the [Express web framework](http://expressjs.com) and [Mongoose ODM](http://mongoosejs.com/). Mongoose is an Object-Document Mapper (ODM) which provides a schema-based solution for modelling data and relationships for documents stored in the [MongoDB database server](https://www.mongodb.com). Keystone extends Mongoose's schema-based models with the concept of a [Keystone List](/api/list/) that helps you build beautiful Admin UIs with intelligent field types.

It provides you with an easy connection to [mongoDB](https://www.mongodb.com/) It wraps both [mongoose](http://mongoosejs.com/) and [expresss](http://expressjs.com/), and provides more detailed database fields, with setups for common information patterns. Why? For the admin UI.
Keystone aims to make it easy for you to create sophisticated web sites and applications, but without restricting how much you can customise your projects. You can bring your own view engine, structure your routes however you want, and modify your data structures to suit your requirements.

Keystone makes it easy to bring your own view engine, structure your routes however you want, and modify your data structures to suit you, all while making doing so easier.
## Prerequisites

1. Make sure you have the [Node.js](https://nodejs.org/en/download/) JavaScript runtime installed. Keystone 4 has been most throughly tested with Node 6, but should be compatible with newer production releases. We recommend using Node LTS (Long Term Support) releases for their extended support lifecycle and stability.

2. You will also need to access to a [MongoDB](https://www.mongodb.com/download-center) database server either installed locally or hosted remotely. Keystone 4 should be compatible with current production releases of MongoDB.

3. You will need a reasonable working knowledge of JavaScript, Node.js, and npm to use Keystone. Basic familiarity with database concepts and MongoDB would also be helpful.

## Where to Begin

### Quick Start Guide

If you want to get a project up and running locally with minimal fuss, so that you can start mucking around, we have a generator, and a handy [yo generator guide](/getting-started/yo-generator) to get you up and running.

The generator provides a full project, ready to `npm start` and customise for your own needs, including optional email and image upload setup.
If you want to get a project up and running locally with minimal fuss, we recommend starting with the [Keystone Yeoman Generator](/getting-started/yo-generator). The Keystone Yeoman Generator provides a prompted experience to help you generate a full project ready to `npm start` with optional features like a basic blog, feedback form, and image gallery.

### Setting Up From Scratch

If you want to write the code from scratch, then check out our [setting up](/getting-started/setting-up/part-1) guide.

It will walk you through setting up the core files and settings to get keystone working, and then allow you to expand outwards, adding what you need when you need it.
If you prefer to write your code from scratch, check out our four part [Setting Up](/getting-started/setting-up/part-1) guide.
This guide will walk you through setting up the core files and settings to get you started with Keystone.

## Where To Next?

Check out our [documentation](/documentation) if you want to get to understanding keystone more, and to explore the options it makes available. The [database configuration](/documentation/database) is a good place to start, as well as looking at the [initialisation options](/documentation/configuration) for the broadest customisation options available.
Check out our [documentation](/documentation) if you want to learn more about Keystone and the available options. [Database Configuration](/documentation/database) is a good place to start, as are the [Keystone Setup Options](/documentation/configuration) for general configuration.

0 comments on commit e26ad60

Please sign in to comment.