Docs content

README.md

@@ -22,6 +22,16 @@ If you use the knex adapter, KeystoneJS _will_ delete your database every time y
 
 ## Getting Started
 
+### Quick start
+
+To get up and running with a basic project template, run the following commands.
+
+```bash
+yarn create keystone-app my-app
+cd my-app
+yarn start
+```
+
 ### Setup
 
 ```

docs/README.md

@@ -0,0 +1,3 @@
+# KeystonJS
+
+Oh hi!

docs/other/README.md

@@ -0,0 +1,2 @@
+This directory contains documention which is not published on the KeystoneJS website.
+It is a holding place for documentation which is either in development, or in the process of being phased out.

docs/quick-start/README.md

@@ -0,0 +1,52 @@
+# Keystone Quick Start
+
+This quick start guide will get you up and running with a fresh new Keystone application in just a few easy commands.
+
+To create a new KeystoneJS application, run the following commands.
+
+```sh
+yarn create keystone-app my-app
+cd my-app
+yarn start
+```
+
+If you see _error_, then make sure you have `mongodb` installed and running.
+
+Congratulation, you are now running your very own Keystone application!
+To visit your running application (a simple todo list), visit
+
+<pre>
+<a href="http://localhost:3000">http://localhost:3000</a>
+</pre>
+
+Your application also has an admin UI, which lets you directly manipulate the data in your database.
+
+<pre>
+<a href="http://localhost:3000/admin/">http://localhost:3000/admin</a>
+</pre>
+
+The [Admin UI Tutorial](../tutorials/admin-ui) will walk you through the functionality provided by the Admin UI.
+
+Both your application and the admin UI are being powered by a GraphQL API.
+Keystone provides a web interface for this API at
+
+<pre>
+<a href="http://localhost:3000/admin/graphiql">http://localhost:3000/admin/graphiql</a>
+</pre>
+
+The [Introduction To GraphQL](../tutorials/intro-to-graphql) tutorial will guide you through the basics of using GraphQL to interact with your Keystone system.
+
+## Installing `mongodb`
+
+### OSX
+
+```sh
+brew install mongodb
+brew services start mongodb
+```
+
+### Linux
+
+```sh
+FIXME (apt-get install mongo or something?)
+```

docs/tutorials/README.md

@@ -0,0 +1,3 @@
+# Tutorials
+
+Welcome to the KeystoneJS tutorials. These tutorials are designed to introduce you to the various concepts within Keystone and take you through worked examples.

docs/tutorials/admin-ui.md

@@ -0,0 +1,3 @@
+# Admin UI
+
+In this tutorial we will take you through the features of the KeystoneJS Admin UI, and show you how to use them to manage your application.

docs/tutorials/intro-to-graphql.md

@@ -0,0 +1,3 @@
+# Introduction To GraphQL
+
+In this tutorial we will introduce you to GraphQL and show you show to use the KeystoneJS GraphQL API to interact with your system.

package.json

@@ -110,7 +110,6 @@
     "isomorphic-unfetch": "^3.0.0",
     "jest": "^24.1.0",
     "jest-junit": "^6.3.0",
-    "kalendaryo": "^1.10.0",
     "keystone-email": "^1.1.0",
     "knex": "^0.16.3",
     "loader-utils": "^1.2.3",

packages/create-keystone-app/README.md

@@ -0,0 +1,7 @@
+# Create Keystone App
+
+```sh
+yarn create keystone-app my-app
+cd my-app
+yarn start
+```

packages/create-keystone-app/package.json

@@ -11,7 +11,7 @@
   "keywords": [
     "keystonejs"
   ],
-  "author": "Gautam Singh <[email protected]>",
+  "author": "The KeystoneJS Development Team",
   "license": "MIT",
   "dependencies": {
     "arg": "^4.1.0",

website/gatsby-config.js

@@ -14,8 +14,8 @@ async function getPackagePlugins() {
     {
       resolve: 'gatsby-source-filesystem',
       options: {
-        name: 'guides',
-        path: `${rootDir}/docs/guides`,
+        name: 'quick-start',
+        path: `${rootDir}/docs/quick-start/`,
       },
     },
     {
@@ -28,8 +28,8 @@ async function getPackagePlugins() {
     {
       resolve: 'gatsby-source-filesystem',
       options: {
-        name: 'getting-started',
-        path: `${rootDir}/docs/getting-started/`,
+        name: 'guides',
+        path: `${rootDir}/docs/guides`,
       },
     },
     ...workspaces

website/src/components/Header.js

@@ -25,8 +25,8 @@ const Logo = () => (
 
 const navLinks = [
   {
-    name: 'Get Started',
-    url: '/getting-started/',
+    name: 'Quick Start',
+    url: '/quick-start',
   },
   {
     name: 'Guides',

website/src/pages/index.js

@@ -87,11 +87,7 @@ const Hero = () => (
             alignItems: 'center',
           }}
         >
-          <Button
-            appearance="primary"
-            href="/getting-started"
-            style={{ margin: 0, marginRight: 8 }}
-          >
+          <Button appearance="primary" href="/quick-start" style={{ margin: 0, marginRight: 8 }}>
             Get Started
           </Button>
           <Button href="https://github.com/keystonejs/keystone-5" style={{ margin: 0 }}>

yarn.lock

@@ -2688,6 +2688,21 @@ anymatch@^2.0.0:
     micromatch "^3.1.4"
     normalize-path "^2.1.1"
 
+apollo-boost@^0.3.1:
+  version "0.3.1"
+  resolved "https://registry.yarnpkg.com/apollo-boost/-/apollo-boost-0.3.1.tgz#b6a896e020a0eab7e415032fe565734a955c65f8"
+  integrity sha512-VdXcTMxLBeNvANW/FtiarEkrRr/cepYKG6wTAURdy8CS33WYpEHtIg9S8tAjxwVzIECpE4lWyDKyPLoESJ072Q==
+  dependencies:
+    apollo-cache "^1.2.1"
+    apollo-cache-inmemory "^1.5.1"
+    apollo-client "^2.5.1"
+    apollo-link "^1.0.6"
+    apollo-link-error "^1.0.3"
+    apollo-link-http "^1.3.1"
+    graphql-tag "^2.4.2"
+    ts-invariant "^0.2.1"
+    tslib "^1.9.3"
+
 [email protected]:
   version "0.5.2"
   resolved "https://registry.yarnpkg.com/apollo-cache-control/-/apollo-cache-control-0.5.2.tgz#47931ede0b11c64d45429850c274b30d19322362"
@@ -2830,6 +2845,15 @@ apollo-link-dedup@^1.0.0:
   dependencies:
     apollo-link "^1.2.3"
 
+apollo-link-error@^1.0.3:
+  version "1.1.8"
+  resolved "https://registry.yarnpkg.com/apollo-link-error/-/apollo-link-error-1.1.8.tgz#3a957b22b843cf6c307d516709cdc42371c9aafe"
+  integrity sha512-5hbMIBaINWOsZapWgTF8H2X0q3NjrQD/y4HlqDnUeLmT12OqejLasNh+EFE6q37/l28UHQu1/AuyRn15J7gvCA==
+  dependencies:
+    apollo-link "^1.2.9"
+    apollo-link-http-common "^0.2.11"
+    tslib "^1.9.3"
+
 apollo-link-error@^1.1.7:
   version "1.1.7"
   resolved "https://registry.yarnpkg.com/apollo-link-error/-/apollo-link-error-1.1.7.tgz#6233a339d732def831af2dd417065b2ffd9feb5c"
@@ -2878,14 +2902,6 @@ apollo-link-http@^1.3.2:
     apollo-link-http-common "^0.2.11"
     tslib "^1.9.3"
 
-apollo-link-http@^1.5.11:
-  version "1.5.11"
-  resolved "https://registry.yarnpkg.com/apollo-link-http/-/apollo-link-http-1.5.11.tgz#1f72a377d03e874a08bc9eadb1ce7ecb166f1e56"
-  integrity sha512-wDG+I9UmpfaZRPIvTYBgkvqiCgmz6yWgvuzW/S24Q4r4Xrfe6sLpg2FmarhtdP+hdN+IXTLbFNCZ+Trgfpifow==
-  dependencies:
-    apollo-link "^1.2.8"
-    apollo-link-http-common "^0.2.10"
-
 apollo-link-state@^0.4.2:
   version "0.4.2"
   resolved "https://registry.yarnpkg.com/apollo-link-state/-/apollo-link-state-0.4.2.tgz#ac00e9be9b0ca89eae0be6ba31fe904b80bbe2e8"