Git Product home page Git Product logo

wordpress-hybrid-client's Introduction

WordPress Hybrid Client

Flattr donate button PayPal donate button

screenshots

Chat

Join the chat at https://gitter.im/shprink/wordpress-hybrid-client

Features

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

Built with WPHC

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.

wordpress-hybrid-client's People

Contributors

shprink avatar mingxia avatar coachbirgit avatar marcorocca avatar andrebalza avatar silverbux avatar xvilo avatar tojaskiba avatar dennisleussink avatar pramttl avatar delitestudio avatar guschaves avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.