feat: (WIP) updating documentation and readme files

Author: Sagar Jain

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 gatsbyjs
+Copyright (c) 2019 Sagar Jain
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,40 +1,27 @@
-# Yellowcake
+# A starter Gatsby template for a Wordpress blog, built using Typescript and Ant Design
 
-[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
-[![dependencies](https://david-dm.org/jinksi/netlify-cms-react-starter.svg?style=flat-square)](https://david-dm.org/jinksi/gatsbro)
+[![Github version](https://img.shields.io/github/package-json/v/sagar7993/gatsby-wordpress-typescript-blog-boilerplate)](https://github.com/sagar7993/gatsby-wordpress-typescript-blog-boilerplate/releases)
+[![GitHub License](https://img.shields.io/github/license/sagar7993/gatsby-wordpress-typescript-blog-boilerplate)](https://opensource.org/licenses/MIT)
+[![GitHub issues](https://img.shields.io/github/issues-raw/sagar7993/gatsby-wordpress-typescript-blog-boilerplate.svg)](https://github.com/sagar7993/gatsby-wordpress-typescript-blog-boilerplate/issues)
 
-An opinionated starter project for creating lightning-fast websites with [Gatsby](https://gatsbyjs.org) v2 and [Netlify CMS](https://netlifycms.org) v2.
+This is an opinionated starter project to help you create lightning fast PWA websites with [Gatsby](https://gatsbyjs.org) and [Wordpress](https://wordpress.com) CMS, built using [Typescript](http://www.typescriptlang.org/) and [Ant Design](https://github.com/ant-design/ant-design).
 
-- **[Gatsby](https://gatsbyjs.org)** static site generator
-- **[Netlify CMS](https://github.com/netlify/netlify-cms)** for content management
-
-## See also
-
-[Netlify CMS Docs](https://www.netlifycms.org/docs/)  
-[Netlify CMS Repo](https://github.com/netlify/netlify-cms)
 
-## Get going
+- **[Gatsby](https://gatsbyjs.org)** static site generator
+- **[Wordpress](https://wordpress.com)** for content management
+- **[Typescript](https://typescriptlang.org)** for statically-typed clean JavaScript code
+- **[Ant Design](https://github.com/ant-design/ant-design)** for theming and UI
 
-[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/thriveweb/yellowcake&stack=cms)
+## Getting started
 
-1.  Hit the **Deploy to Netlify** button. This will:
+Hit the **Deploy to Netlify** button. This will:
 
 - Clone the repo into your Github account
-- Create you a new project on Netlify, build & deploy
-
-1.  Once your Netlify project has been created, check a couple of settings:
+- Create a new project on Netlify, build & deploy
 
-- Enable **Identity**
-- Change **Registration Preferences** to **Invite Only**
-- Enable **Git Gateway**
+## Setting up Wordpress
 
-1.  Invite users (probably yourself) to enable admin access
-
-- Open the **Identity** tab and hit **Invite Users**
-
-## Show me the CMS!
-
-The CMS lives at [\_\_YOUR_SITE_NAME\_\_.netlify.com/admin](https://__YOUR_SITE_NAME__.netlify.com/admin).
+Use the included docker-compose.yml file to setup Wordpress on your local machine
 
 ## Developing
 
@@ -143,6 +130,4 @@ Get Your Instagram Access Token [here](https://generator.thrivex.io/). In order
 
 ## 💫 Deploy
 
-[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/gatsbyjs/gatsby-starter-hello-world)
-
-<!-- AUTO-GENERATED-CONTENT:END -->
+[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/sagar7993/gatsby-wordpress-typescript-blog-boilerplate)

docker-compose.yml

@@ -0,0 +1,48 @@
+version: '3'
+
+services:
+  # Database
+  db:
+    image: mysql:5.7
+    volumes:
+      - db_data:/var/lib/mysql
+    restart: always
+    environment:
+      MYSQL_ROOT_PASSWORD: password
+      MYSQL_DATABASE: wordpress
+      MYSQL_USER: wordpress
+      MYSQL_PASSWORD: wordpress
+    networks:
+      - wpsite
+  # phpmyadmin
+  phpmyadmin:
+    depends_on:
+      - db
+    image: phpmyadmin/phpmyadmin
+    restart: always
+    ports:
+      - '8080:80'
+    environment:
+      PMA_HOST: db
+      MYSQL_ROOT_PASSWORD: password 
+    networks:
+      - wpsite
+  # Wordpress
+  wordpress:
+    depends_on:
+      - db
+    image: wordpress:latest
+    ports:
+      - '8001:80'
+    restart: always
+    volumes: ['./:/var/www/html']
+    environment:
+      WORDPRESS_DB_HOST: db:3306
+      WORDPRESS_DB_USER: wordpress
+      WORDPRESS_DB_PASSWORD: wordpress
+    networks:
+      - wpsite
+networks:
+  wpsite:
+volumes:
+  db_data:

package.json

@@ -40,7 +40,7 @@
   },
   "dependencies": {
     "antd": "^3.0.0",
-    "axios": "^0.1.0",
+    "axios": "^0.19.0",
     "gatsby": "^2.0.0",
     "gatsby-image": "^2.0.0",
     "gatsby-paginate": "^1.0.0",

src/pages/index.tsx

@@ -32,7 +32,7 @@ export const IndexPage = (props: Props) => {
 				<Card>
 					<Row gutter={24} type="flex" align="middle">
 						<Col xs={24} sm={24} md={24} lg={24} xl={24} xxl={24}>
-							<h2>This is an opinionated starter project to help you create lightening fast PWA websites with Gatsby and Wordpress CMS, built using Typescript and Ant Design.</h2>
+							<h2>This is an opinionated starter project to help you create lightning fast PWA websites with Gatsby and Wordpress CMS, built using Typescript and Ant Design.</h2>
 							{fluid && <Image fluid={fluid} alt="Home screen banner" title="Home screen banner" />}
 						</Col>
 						<Col xs={24} sm={24} md={24} lg={24} xl={24} xxl={24}>