Skip to content

Instantly share code, notes, and snippets.

@chadwilken
Last active July 9, 2018 15:20

Revisions

  1. chadwilken revised this gist Jul 9, 2018. 2 changed files with 2 additions and 0 deletions.
    1 change: 1 addition & 0 deletions collection.md
    Original file line number Diff line number Diff line change
    @@ -11,6 +11,7 @@
    |`materials`|`Array<string>`|A list of materials the user used in the collection|
    |`featuredPhoto`|`string`|A URL to a featured image|
    |`photos`|`Array<Photo>`|A list of photo objects containing a uri to the photo and it's creation time as a Unix timestamp|
    |`companyLogo`|`String`|A logo or null for the company|
    |`seoData`|`SeoData`|SEO data used for the various `title` and `meta` tags|

    ##### Notes
    1 change: 1 addition & 0 deletions payload.json
    Original file line number Diff line number Diff line change
    @@ -7,6 +7,7 @@
    "categories": ["roofing", "reshingle", "flat roof"],
    "materials": ["Owens Corning Weather Wood", "Tar Paper"],
    "featuredPhoto": "https://static.companycam.com/8/roofing-project-2012501-1527873498-orig-f85140ef.jpg",
    "companyLogo": "https://static.companycam.com/8/logo/small-a68298d9.png",
    "photos": [
    {
    "uri": "https://static.companycam.com/8/roofing-project-2012501-1527873498-orig-f85140ef.jpg",
  2. chadwilken revised this gist Jun 8, 2018. 1 changed file with 20 additions and 1 deletion.
    21 changes: 20 additions & 1 deletion collection.md
    Original file line number Diff line number Diff line change
    @@ -5,8 +5,27 @@
    |`version`|`int`|The version of the photo collection, will increase as modifications are made|
    |`collectionUUID`|`string`|A unique identifier for the collection, it will remain the same with subsequent versions|
    |`title`|`string`|The title of the collection|
    |`subtitle`|`string`|The subtitle of the collection|
    |`description`|`string`|The long description explaining the project|
    |`categories`|`Array<string>`|A list of categories the user applied to the collection|
    |`materials`|`Array<string>`|A list of materials the user used in the collection|
    |`featuredPhoto`|`string`|A URL to a featured image|
    |`photos`|`Array<{uri: string, createdAt: int}>`|A list of photo objects containing a uri to the photo and it's creation time as a Unix timestamp|
    |`photos`|`Array<Photo>`|A list of photo objects containing a uri to the photo and it's creation time as a Unix timestamp|
    |`seoData`|`SeoData`|SEO data used for the various `title` and `meta` tags|

    ##### Notes
    The `title` should be used for the templates `h1` and the `subtitle` for the `h2`.

    ## Photo
    |Attribute|Type|Description|
    |---------|----|-----------|
    |`uri`|`string`|The URI to the photo|
    |`createdAt`|`int`|The Unix timestamp when the photo was captured|
    |`filename`|`string`|The filename as it should be stored in Wordpress|
    |`alt`|`string`|The text to use for the photos alt text|

    ## SeoData
    |Attribute|Type|Description|
    |---------|----|-----------|
    |`title`|`string`|The value to be used for the `title` tag of the page|
    |`metaDescription`|`string`|The value to use for the `meta` tag with the name "description"|
  3. chadwilken revised this gist Jun 7, 2018. 2 changed files with 10 additions and 3 deletions.
    File renamed without changes.
    13 changes: 10 additions & 3 deletions payload.json
    Original file line number Diff line number Diff line change
    @@ -1,15 +1,22 @@
    {
    "version": 1,
    "collectionUUID": "93764b81-382b-4bda-ba14-95833707f882",
    "title": "The CompanyCam Roof Project",
    "title": "Residential Roofing Project",
    "subtitle": "Near 12th & Aberdeen Lincoln NE 68512",
    "description": "CompanyCam needed a new roof on their old building, so we took the job and made another happy customer.",
    "categories": ["roofing", "reshingle", "flat roof"],
    "materials": ["Owens Corning Weather Wood", "Tar Paper"],
    "featuredPhoto": "https://static.companycam.com/8/roofing-project-2012501-1527873498-orig-f85140ef.jpg",
    "photos": [
    {
    "uri": "https://static.companycam.com/8/roofing-project-2012501-1527873498-orig-f85140ef.jpg",
    "createdAt": 1528406547
    "createdAt": 1528406547,
    "filename": "residential-roofing-white-castle-roofing-near-12th-aberdeen-lincoln-NE-68516.jpg",
    "alt": "Residential Roofing White Castle Roofing Near Cross Streets Lincoln NE 68516"
    }
    ]
    ],
    "seoData": {
    "title": "Residential Roofing Project Near 12th & Aberdeen, Lincoln NE 68516 | White Castle Roofing",
    "metaDescription": "Residential Roofing Project Near 12th & Aberdeen, Lincoln NE 68516 | Presented by White Castle Roofing | Materials used: Shingles, Owens Corning, 3 Tab Shingles, Composite Shingles..."
    }
    }
  4. chadwilken revised this gist Jun 7, 2018. 2 changed files with 15 additions and 4 deletions.
    6 changes: 3 additions & 3 deletions payload.json
    Original file line number Diff line number Diff line change
    @@ -5,11 +5,11 @@
    "description": "CompanyCam needed a new roof on their old building, so we took the job and made another happy customer.",
    "categories": ["roofing", "reshingle", "flat roof"],
    "materials": ["Owens Corning Weather Wood", "Tar Paper"],
    "featuredImage": "https://static.companycam.com/8/roofing-project-2012501-1527873498-orig-f85140ef.jpg",
    "images": [
    "featuredPhoto": "https://static.companycam.com/8/roofing-project-2012501-1527873498-orig-f85140ef.jpg",
    "photos": [
    {
    "uri": "https://static.companycam.com/8/roofing-project-2012501-1527873498-orig-f85140ef.jpg",
    "created_at": 1528406547
    "createdAt": 1528406547
    }
    ]
    }
    13 changes: 12 additions & 1 deletion schema.md
    Original file line number Diff line number Diff line change
    @@ -1 +1,12 @@
    ### Collection
    ## Photo Collection

    |Attribute|Type|Description|
    |---------|----|-----------|
    |`version`|`int`|The version of the photo collection, will increase as modifications are made|
    |`collectionUUID`|`string`|A unique identifier for the collection, it will remain the same with subsequent versions|
    |`title`|`string`|The title of the collection|
    |`description`|`string`|The long description explaining the project|
    |`categories`|`Array<string>`|A list of categories the user applied to the collection|
    |`materials`|`Array<string>`|A list of materials the user used in the collection|
    |`featuredPhoto`|`string`|A URL to a featured image|
    |`photos`|`Array<{uri: string, createdAt: int}>`|A list of photo objects containing a uri to the photo and it's creation time as a Unix timestamp|
  5. chadwilken created this gist Jun 7, 2018.
    15 changes: 15 additions & 0 deletions payload.json
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,15 @@
    {
    "version": 1,
    "collectionUUID": "93764b81-382b-4bda-ba14-95833707f882",
    "title": "The CompanyCam Roof Project",
    "description": "CompanyCam needed a new roof on their old building, so we took the job and made another happy customer.",
    "categories": ["roofing", "reshingle", "flat roof"],
    "materials": ["Owens Corning Weather Wood", "Tar Paper"],
    "featuredImage": "https://static.companycam.com/8/roofing-project-2012501-1527873498-orig-f85140ef.jpg",
    "images": [
    {
    "uri": "https://static.companycam.com/8/roofing-project-2012501-1527873498-orig-f85140ef.jpg",
    "created_at": 1528406547
    }
    ]
    }
    1 change: 1 addition & 0 deletions schema.md
    Original file line number Diff line number Diff line change
    @@ -0,0 +1 @@
    ### Collection