Ckbhatia / Ck-gatsby-blog

A beautiful and featureful gatsby blog starter for bloggers. It is an open-source project.
https://chetanblog.netlify.com
MIT License
37 stars 33 forks source link

Add and improve README #5

Closed Ckbhatia closed 4 years ago

Ckbhatia commented 4 years ago

Please improve the README file. It should be easier for people to understand.

Add contentful API key and secret key to demo purpose.

Space ID: zorf8a5obm1d Content Delivery API - access token: v4WRlGF6fTfBUrP54Hbaiava6VjPgKbW8mFEOgzEiPY

this could be used for developers who want to run this project on their local machine to test or contribute to it.

Copy this JSON file and create a gist and add that link in README. It is for people's reference purpose.

Contentful Content Model:

{
  "name": "Article Demo",
  "description": "",
  "displayField": "title",
  "fields": [
    {
      "id": "title",
      "name": "Title",
      "type": "Symbol",
      "localized": false,
      "required": true,
      "validations": [],
      "disabled": false,
      "omitted": false
    },
    {
      "id": "slug",
      "name": "Slug",
      "type": "Symbol",
      "localized": false,
      "required": true,
      "validations": [
        {
          "unique": true
        }
      ],
      "disabled": false,
      "omitted": false
    },
    {
      "id": "thumbnail",
      "name": "Thumbnail",
      "type": "Link",
      "localized": false,
      "required": true,
      "validations": [],
      "disabled": false,
      "omitted": false,
      "linkType": "Asset"
    },
    {
      "id": "topic",
      "name": "Topic",
      "type": "Symbol",
      "localized": false,
      "required": true,
      "validations": [],
      "disabled": false,
      "omitted": false
    },
    {
      "id": "author",
      "name": "Author",
      "type": "Symbol",
      "localized": false,
      "required": true,
      "validations": [],
      "disabled": false,
      "omitted": false
    },
    {
      "id": "published",
      "name": "Published",
      "type": "Date",
      "localized": false,
      "required": true,
      "validations": [],
      "disabled": false,
      "omitted": false
    },
    {
      "id": "body",
      "name": "Body",
      "type": "RichText",
      "localized": false,
      "required": true,
      "validations": [
        {
          "nodes": {}
        }
      ],
      "disabled": false,
      "omitted": false
    }
  ],
  "sys": {
    "space": {
      "sys": {
        "type": "Link",
        "linkType": "Space",
        "id": "zorf8a5obm1d"
      }
    },
    "id": "title",
    "type": "ContentType",
    "createdAt": "2020-10-02T16:37:14.393Z",
    "updatedAt": "2020-10-02T16:59:46.498Z",
    "environment": {
      "sys": {
        "id": "master",
        "type": "Link",
        "linkType": "Environment"
      }
    },
    "publishedVersion": 3,
    "publishedAt": "2020-10-02T16:59:46.498Z",
    "firstPublishedAt": "2020-10-02T16:37:17.547Z",
    "createdBy": {
      "sys": {
        "type": "Link",
        "linkType": "User",
        "id": "6V4L3w8wDYBUrcm3itF89M"
      }
    },
    "updatedBy": {
      "sys": {
        "type": "Link",
        "linkType": "User",
        "id": "6V4L3w8wDYBUrcm3itF89M"
      }
    },
    "publishedCounter": 2,
    "version": 4,
    "publishedBy": {
      "sys": {
        "type": "Link",
        "linkType": "User",
        "id": "6V4L3w8wDYBUrcm3itF89M"
      }
    }
  }
}

Add a note that project fork or clone can be modified if they want to customization in their own copy.

Please improve this readme file for open-source contributors.

Ckbhatia commented 4 years ago

Please star the project when you want to contribute to this project

YeisonTapia commented 4 years ago

Hi, I'll like to work in this issue. @Ckbhatia let me know if I can.

Ckbhatia commented 4 years ago

@YeisonTapia I am happy to see your interest to work on this issue. I have fixed this issue as requirements changed.

Can you please choose any other issue, I will assign anyone that you like to work on?