ABOUT

An advanced blog Wordpres project about coding by Noweh and Rapkalin.

HOW TO INSTALL THE PROJECT

1/ BACKEND

1.1_ Create the directory on your computer

mkdir your-directory-name

1.2_ Clone the website project from your directory (don't forget the . at the end):

git clone git@github.com:Rapkalin/explain-code.git .

1.3_ Move to the project directory and install the backend dependencies:

• cd your-directory-name
• composer install

1.4_ Copy the .env.sample file, rename it to .env and complete the needed variables:

DATABASE_NAME='your-database-name'
DATABASE_USER='your-database-username'
DATABASE_PASSWORD='your-database-password'
DATABASE_HOST='your-host'

WP_ENV=local
WP_CONTENT_URL=http://explain-code.local/
WP_SITEURL=http://explain-code.local/

# USED FOR DATABASE IMPORT SCRIPTS
PROD_HOST=
PROD_USER=
PROD_SITEURL=
DATABASE_PROD_HOST=
DATABASE_PROD_NAME=
DATABASE_PROD_USER=
DATABASE_PROD_PASSWORD=

1.5_ Configure your vHost

• ServerName: explain-code.local
• Directory: your-directory-name/website

  <VirtualHost *:80>
    ServerName explain-code.local
    DocumentRoot "/Users/r.kalinowski/Sites/explain-code/website"
    ServerAlias explain-code.local.*
    <Directory "/Users/r.kalinowski/Sites/explain-code/website">
      Options Includes FollowSymLinks
      AllowOverride All
    </Directory>
 </VirtualHost>

1.6_ Import prod database

cd your-directory-name
php scripts/import-db.php

1.7_ Import the uploads directory from prod to local

cd your-directory-name
php scripts/sync-uploads.php

2/ FRONTEND

• For each update of the newsmatic theme, you have to change/refresh website/app/themes/newsmatic-child/assets/js/theme.js to reflect the change

3/ TRANSLATIONS

The explain-code.pot file is the website's base language

• Download and open the free poedit software
• Translation functions to use:
  • __: Translate
  • _e: Translate and displays
  • _n: Translate and displays the plural

3.1_ ADD A NEW LANGUAGE

If the translation file doesn't exist in the language you want:

• Open the Poedit software
• Create a new file from the explain-code.pot file to retrieve all words to translate
• Name it with the code needed code langage. Example: en_US

3.2_ ADD A NEW WORD TO TRANSLATE

If you want to add a new word to translate:

• Open the explain-code.pot file with poedit
• Go to the translate (or catalog) menu
• Click on update source code to retrieve all new translations added in the code

MEANING OF SOME DIRECTORIES AND FILES

4/ WEBSITE/APP

This directory replace the wordpress-core/wp-content native Wordpress directory. This is where you will find all the plugins, themes etc:

• W3 Super Cache: this plugin install a few files and directories:
  • cache
  • w3tc-config
  • advanced-cache.php
• Languages: directory that handle the translations of your website. It is created by Wordpress when you configure the default language of your Wordpress website.
• Uploads: contains all the website's media files
• Plugins and themes: where are all the plugins & themes and custom plugins & themes/child-themes

5/ HOW TO DEPLOY

To use the auto-deploy using Github Workflows please follow the below instructions:

• Commit and push your branch (feature/xxx) to main
• Wait for approval and merge
• Once the PR approved and merged, pull the changes from main

  git checkout main
  git pull

• Create the new tag after checking the last published here: Github Actions

  git tag x.x.x

• Push the new tag, this will deploy the main branch automatically to prod

  git push --tags