amanintech/Twimcast-amp-theme

paired amp experience with 100 % valid amp component and drag and drop home screen

Twimcast - Amp - Theme : A wordpress theme

Twimcast - Amp - Theme is a 100% valid feed amp theme for wordpress.

Tech Stack

• Frontend: HTML5, CSS3, JavaScript, Amp
• Backend: WordPress

Getting Started

System Requirements

As this is a wordpress theme application, you need the following to support your development environment.

• Git
• mySQL
• Linux Based Terminal, if you're using Windows and installed with Git.
• Google Chrome or a decent latest web browser.
• Any Text Editor: Vim, Terminal, VS Code, etc.

Installation Instructions

WordPress Installation

• Download Xampp

• Set up Apache Server and MySQL in the Xampp Control Panel

• Download WordPress

• Copy the extracted WordPress folder and Paste it to .../Xampp/htdocs/

• Open Chrome and type localhost/phpmyadmin

• Create and configure a new database

• Type localhost/<your downloaded wordpress folder name>/

• Complete the WordPress installation by following the steps mentioned on the website

  • Default WordPress username: root

  • Default WordPress password: <no password>

• Configure the WordPress with site name, custom username and password

• Submit Install WordPressand Login with your custom credentials.

  WordPress is installed and configured. You should be able to access your Dashboard.

Theme Installation

• Clone the following theme and paste it under .../Xampp/<Your Wordpress folder name>/wp-content/themes

  • twimbit-amp-theme

• Activate the theme underWordpress Dashboard > Appearance

  Theme is installed and activated. You should be able to see them in your Dashboard

Plugins Installation

• Clone the following plugins and paste them under .../Xampp/<Your Wordpress folder name>/wp-content/plugins

  • twimbit-api
  • wpgraphql-acf
  • wpgraphql
  • wpgraphql-cpt
  • gutenberg
  • amp( can be downloaded via WordPress Dashboard > Plugins > Add Plugins )
  • radio buttons for taxonomy (can be downloaded via WordPress Dashboard > Plugins > Add Plugins)

• Activate all the plugins at WordPress Dashboard > Plugins after adding them

  Plugins are installed and activated. You should be able to see them in your Dashboard

  You are ready to contribute to the Twimbit-Amp-Theme project.

Contribution Guidelines

• Please read our Code of Conduct and Gitflow for contributing towards the project.
• Write clear meaningful git commit messages (Do read this).
• Make sure your PR's description contains GitHub's special keyword references that automatically close the related issue when the PR is merged. (Check this for more info)
• When you make very very minor changes to a PR of yours (like for example fixing a text in button, minor changes requested by reviewers) make sure you squash your commits afterwards so that you don't have an absurd number of commits for a very small fix. (Learn how to squash at here)
• When you're submitting a PR for a UI-related issue, it would be really awesome if you add a screenshot of your change or a link to a deployment where it can be tested out along with your PR. It makes it very easy for the reviewers and you'll also get reviews quicker.
• Always create PR to develop branch.

Mentors

GitHub Usernames	Domain
Aman Sharma (@amanintech)	Full Stack
Siddhant Kumar (@siddhantdante)	Full Stack