Skip to content

Sample app using product collections views in the Contentful webapp

License

Notifications You must be signed in to change notification settings

rarcifa/cf-app-collections

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Collection App

The Collection App provides a list/grid view of product lists which will be available within the web app.

Lists examples:

  • Products and Items
  • Events
  • Any other listable object

The Collection App utilizes the Contentful JSON Field to store a collection with objects Collection data stucture:

{
    id: string;
    list: [
        {
            name: string;
            value: string;
            image: string;
            category: string;
        }
    ]
}

Note that the id property is automatically generated and useful for developers to differentiate between different collections even if the labels are the same or similar

An example item in the Contentful response:

{
    "fields": {
        "collection": [
            {
                "name": "Luke Skywalker",
                "value": "Luke Skywalker",
                "image": "https://media.contentapi.ea.com/content/dam/star-wars-battlefront-2/images/2019/08/swbf2-refresh-hero-large-heroes-page-luke-skywalker-16x9-xl.jpg.adapt.crop1x1.320w.jpg",
                "category": "Starwars"
            },
            {
                "name": "C-3PO",
                "value": "C-3PO",
                "image": "https://i.pinimg.com/564x/ae/cc/e5/aecce55bc3c39e0a4f9109e619a8806c.jpg",
                "category": "Starwars"
            },
            {
                "name": "R2-D2",
                "value": "R2-D2",
                "image": "https://www.space-figuren.de/images/product_images/info_images/9696_0.jpg",
                "category": "Starwars"
            }
        ]
    }
}

For Developers: Running This App Locally

This project was bootstrapped with Create Contentful App.

Before running the app locally, you will need to do 2 things:

  • Ensure your Contentful user is admin or developer for the organization.
  • Create an AppDefinition in your organization with the following properties:
    • The App URL: http://localhost:3000
    • An entry field location with a type of JSON Object
    • An instance parameter of type short text with the id valueName

Once your app definition is created, running npm start will start a local server on port 3000 (http://localhost:3000).

You must create or modify a content type which has a JSON field in order to see the app inside of the Contentful web app.

Learn More

Read more and check out the video on how to use the CLI.

Create Contentful App uses Create React App. You can learn more in the Create React App documentation and how to further customize your app.

About

Sample app using product collections views in the Contentful webapp

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages