README.md

WordPress Hybrid Client

Chat

Features

• Posts
• Pages
• Custom posts
• Taxonomies (Category, Tag and custom)
• Authors
• Search
• Push Notifications
• Custom templates (overwrite any template of the app)
• Social sharing
• Admob support
• Sass variables
• Parameters Page - Language switch [English|French|Chinese|Spanish|Polish|German|Portuguese|Italian|Dutch|Russian|Turkish|Urdu] - Accessibility (Post font size)
• Image cache on device
• App rate plugin
• Syntax highlighter
• Offline (Bookmarks)
• Comments (Submitting is not supported yet)

Built with WPHC

• Android
  • https://play.google.com/store/apps/details?id=com.shprinkinc.wordpresshybridclient
  • http://hiwaldorf.com/app/
  • https://play.google.com/store/apps/details?id=fr.silentkernel.app
  • https://play.google.com/store/apps/details?id=com.notmyfault
  • https://play.google.com/store/apps/details?id=com.ek.klootschieten
  • https://play.google.com/store/apps/details?id=ca.siksik.SikSikYFB
  • https://play.google.com/store/apps/details?id=com.trouidees.nuustoep&hl=en
• IOS
  • https://itunes.apple.com/cn/app/id1030393337
  • https://itunes.apple.com/us/app/not-my-fault./id886617889
  • https://itunes.apple.com/us/app/ek-klootschieten-2016/id1095442611
  • https://itunes.apple.com/ca/app/siksik-iqaluit-city-guide/id935965604
  • https://itunes.apple.com/WebObjects/MZStore.woa/wa/viewSoftware?id=1083903483&mt=8
  • https://itunes.apple.com/us/app/blog-da-suzye/id1117503697
  • https://itunes.apple.com/us/app/roma-tattoo/id1117043450
  • https://itunes.apple.com/us/app/blog-da-amanda-coutinho/id1114539494

Quick Start

Prerequisites

• Git
• NodeJS (recommended: 4.x), please do not use npm 5.x for now
• NPM (recommended: 3.3.x)

This installation works on both OSX and Linux. Windows is not supported yet,

# Clone and use the latest version
$ git clone https://github.com/shprink/wordpress-hybrid-client.git && cd wordpress-hybrid-client
# List all versions
$ git tag
$ git checkout <the-latest-version>

# Install
$ npm install && npm run installWPHC

# Run on the browser
$ npm run devserver

Open http://localhost:8080/webpack-dev-server/ in Chrome (the only browser supported). You should see the application running with http://dev.julienrenaux.fr/wp-json backend.

To go further please read the documentations.

Documentation

If you have just cloned the repository, INSTALLATION is the recommended starting point. Here is the documentation index:

Installation

Read the manual: INSTALLATION.md

Configuration

Read the manual: CONFIGURATION.md

Development

Read the manual: DEVELOPMENT.md

Push Notifications

Read the manual: PUSHNOTIFICATIONS.md

Build Android & iOS

Read the manual: BUILD.md

Release Android & iOS

Read the manual: RELEASE.md

Splashscreens and Icons

Read the manual: SPLASHICONS.md

Project public API

# Dev server
npm run devserver

# Dump files in www
npm run dumpdev
npm run dumpprod

# Run Cordova
npm run android
npm run ios
npm run iosEmulator

# Cordova build
npm run buildAndroid
npm run buildProdAndroid
npm run buildIOS
npm run buildProdIOS

Contribute

WordPress hybrid Client is Open Source, If you are interested in helping, please read the following:

Pull Request Guidelines

When in doubt, keep your pull requests small. To give a PR the best chance of getting accepted, do not bundle more than one "feature" or bug fix in one PR. Doing so makes it very hard to accept it if one of the fixes has issues.

It's always best to create two smaller PRs than one big one.

Style

Always use four spaces, no tabs. This goes for any HTML, CSS, or Javascript.