You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+34-10Lines changed: 34 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,37 @@
1
-
This project was bootstrapped with [Create Contentful App](https://github.com/contentful/create-contentful-app).
1
+
# Contentful Ingredients Field App
2
2
3
-
## Available Scripts
3
+
This [Contentful App](https://www.contentful.com/developers/docs/extensibility/app-framework/) adds a custom UI that can be used on top of the [JSON Object](https://www.contentful.com/developers/docs/concepts/data-model/) field type and represents a list of ingredients for recipes.
Inspired by [this video](https://www.youtube.com/watch?v=OtmV3TPTbRs) and bootstrapped with [Create Contentful App](https://github.com/contentful/create-contentful-app).
8
+
9
+
## Data structure
10
+
11
+
The data produced by the ingredients field type looks like this:
12
+
13
+
```json
14
+
[
15
+
{
16
+
"amount": "2 tbsp",
17
+
"id": "4skkkYCvbdHVhRfI5hdW7o"
18
+
},
19
+
{
20
+
"amount": "3 tsp",
21
+
"id": "2xFnDNGBloZzp59kddJBI6"
22
+
},
23
+
{
24
+
"amount": "200g",
25
+
"id": "2uqKK4iWHxhlRrGn24OLvy"
26
+
}
27
+
]
28
+
```
29
+
30
+
`id` represents a relation to an entry of a collection named `"ingredients"`.
31
+
32
+
`amount` is an unformatted string holding information about how much to use of the referenced ingredient.
33
+
34
+
## Development
4
35
5
36
In the project directory, you can run:
6
37
@@ -20,14 +51,7 @@ It correctly bundles React in production mode and optimizes the build for the be
20
51
The build is minified and the filenames include the hashes.
21
52
Your app is ready to be deployed!
22
53
23
-
## Libraries to use
24
-
25
-
To make your app look and feel like Contentful use the following libraries:
26
-
27
-
-[Forma 36](https://f36.contentful.com/) – Contentful's design system
28
-
-[Contentful Field Editors](https://www.contentful.com/developers/docs/extensibility/field-editors/) – Contentful's field editor React components
29
-
30
-
## Learn More
54
+
## More about Contentful Apps
31
55
32
56
[Read more](https://www.contentful.com/developers/docs/extensibility/app-framework/create-contentful-app/) and check out the video on how to use the CLI.
0 commit comments