summaryrefslogtreecommitdiff
path: root/docs/src/Quickstart
diff options
context:
space:
mode:
authorSteve Manuel <nilslice@gmail.com>2017-05-27 10:27:51 -0700
committerSteve Manuel <nilslice@gmail.com>2017-05-27 10:27:51 -0700
commit78de7ed98abff93fe5fef94907bcfa4f76dcef07 (patch)
treef58578554dc829a046762e588d8b190af89dd992 /docs/src/Quickstart
parent38aa0ebb1df97ff185d84da2d3c2f9a11888729b (diff)
adding docs to repo
Diffstat (limited to 'docs/src/Quickstart')
-rw-r--r--docs/src/Quickstart/Overview.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/docs/src/Quickstart/Overview.md b/docs/src/Quickstart/Overview.md
new file mode 100644
index 0000000..6c4bec5
--- /dev/null
+++ b/docs/src/Quickstart/Overview.md
@@ -0,0 +1,38 @@
+### Quickstart Steps
+1) Install [Go 1.8+](https://golang.org/dl/)
+
+2) Install Ponzu CLI:
+```bash
+$ go get github.com/ponzu-cms/ponzu/…
+```
+
+3) Create a new project (path is created in your GOPATH):
+```bash
+$ ponzu new github.com/nilslice/reviews
+```
+
+4) Enter your new project directory:
+```bash
+$ cd $GOPATH/src/github.com/nilslice/reviews
+```
+
+5) Generate content type file and boilerplate code (creates `content/review.go`):
+```bash
+$ ponzu generate content review title:"string" author:"string" rating:"float64" body:"string":richtext website_url:"string" items:"[]string" photo:string:file`
+```
+
+6) Build your project:
+```bash
+$ ponzu build
+```
+
+7) Run your project with defaults:
+```bash
+$ ponzu run
+```
+
+8) Open browser to [`http://localhost:8080/admin`](http://localhost:8080/admin)
+
+### Notes
+- One-time initialization to set configuration
+- All fields can be changed in Configuration afterward