Skip to content

Latest commit

 

History

History
79 lines (51 loc) · 3.92 KB

README.md

File metadata and controls

79 lines (51 loc) · 3.92 KB
Raw

MrHyde

Playstore banner

Avoid turning yourself into a raging monster by using our Android app to ease blogging using Jekyll and GitHub pages.

Available on the Google Playstore!

The repository is divided into two parts:

  • client: the android application which has been published on the Google Playstore
  • server: the server which handles creating and temporarily hosting Jekyll previews

Client

Setting up the android client is fairly straight forward. The only things that's missing are a number of API keys which should be added to the app/src/main/res/values folder. They are:

<resources>
    <string name="gitHubClientSecret">YOUR_GITHUB_CLIENT_SECRET</string>
    <string name="gitHubClientId">YOU_GITHUB_ID</string>
    
    <string name="bitbucketClientSecret">YOUR_BITBUCKET_SECRET</string>
    <string name="bitbucketClientId">YOUR_BITBUCKET_CLIENT_ID</string>
    
    <string name="jekyllServerClientSecret">CLIENT_SECRET_FOR_MRHYDE_SERVER</string>
</resources>

For getting a proper GitHub client id and secret you will have to register your application with GitHub.

The jekyllServerClientSecret should match the one configured on the MrHyde server. This key is only required for the preview functionality and can also be left empty. See the server configuration section below for details.

Server

The MrHyde Server gets requests from the clients, builds the page and returns a link to the built page to the clients, so they can preview it. The server is mainly written in Python. It requires some setup to run and currently only works on systems that have the ability to create subdomains by just creating a new folder.

Basic idea behind how the server works:

Server gets a request from a client, clones the repo and applies a diff, then calls jekyll on this repo. The Client meanwhile gets the link to a dart/js script, that polls for the console output of the jekyll instance and the status code of the jekyll instance. As soon as the status code is 0, the script will redirect to the jekyll html output.

Setup

Requirements

Configuration

There is a config_example.ini in the server root folder. Copy/Rename it to config.ini and open and edit it:

  • [default]path = # Path where the repos are going to be stored
  • [default]deploy_path = # Path where the built page is going to be deployed from
  • [default]deploy_path_append = # This string is going to be appended to the deploy_path after the id. So it's deploy_path+"/"+id+deploy_path_append
  • [default]url = # the URL the server is going to run on. Should just stay the way it is, unless you want to edit the code aswell
  • [default]client_secret = # A secret the client has to know aswell, so you can make sure that only your clients use your server
  • [database]path = # the path and name of the database
  • [repo]id_length =

License

Source Code

Copyright 2015 FauDroids

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Artwork

CC BY 4.0