aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/get-started-cli.md70
1 files changed, 65 insertions, 5 deletions
diff --git a/docs/get-started-cli.md b/docs/get-started-cli.md
index d78a9a5..ddf5102 100644
--- a/docs/get-started-cli.md
+++ b/docs/get-started-cli.md
@@ -4,19 +4,79 @@
Create a new folder for your project, `my-project`. Change into it, and set `AMCS_CONTENT` to the folder that should store your content.
-```
+```console
mkdir -p my-project
cd my-project
export ACMS_CONTENT=$PWD/content
```
-## Create a restaurant collection
+## Create a restaurant collection type
-```
+```console
acms collection insert restaurant/1.json <<'EOF'
{
- "name": "Biscotte Restaurant",
- "description": "Welcome to Biscotte restaurant! Restaurant Biscotte offers a cuisine based on fresh, quality products, often local, organic when possible, and always produced by passionate producers."
+ "name": "Biscotte Restaurant",
+ "description": "Welcome to Biscotte restaurant! Restaurant Biscotte offers a cuisine based on fresh, quality products, often local, organic when possible, and always produced by passionate producers."
+}
+EOF
+```
+
+## Create a category collection type
+
+```console
+acms collection insert category/1.json <<'EOF'
+{
+ "name": "French Food",
+ "restaurant": "1.json"
+}
+EOF
+```
+
+```console
+acms collection insert category/2.json <<'EOF'
+{
+ "name": "Brunch",
+ "restaurant": "1.json"
}
EOF
```
+
+## Query the API
+
+```console
+curl 'http://localhost:8081' --data '
+ SELECT
+ {
+ name: restaurant.name,
+ description: restaurant.description,
+ category: {
+ category: category.name
+ }
+ }
+ FROM
+ restaurant
+ LEFT JOIN
+ category
+ ON
+ category.restaurant == restaurant.$fileName
+' | jq .
+```
+
+```json
+[
+ {
+ "category": {
+ "category": "French Food"
+ },
+ "description": "Welcome to Biscotte restaurant! Restaurant Biscotte offers a cuisine based on fresh, quality products, often local, organic when possible, and always produced by passionate producers.",
+ "name": "Biscotte Restaurant"
+ },
+ {
+ "category": {
+ "category": "Brunch"
+ },
+ "description": "Welcome to Biscotte restaurant! Restaurant Biscotte offers a cuisine based on fresh, quality products, often local, organic when possible, and always produced by passionate producers.",
+ "name": "Biscotte Restaurant"
+ }
+]
+```