GoGEM

README

GoGEM

About

GoGEM is a tool designed to make the deployment process of your iGEM-Wiki as easy as possible. It is able to automatically fetch a page from a WordPress Instance hosted by your team. If you use this tool please give credit to me and link to this repo (https://github.com/Jackd4w/GoGEM).

Installation

To install this programm you can use the go install github.com/Jackd4w/GoGEM command. alternatively the cloning of this repo and go run or go build can be used.

A pre-compiled version will be available with each release.

Usage

If installed the tool can be used by executing the GoGEM command in your CLI.

If you want to use a pre-compiled version you will have to download the executables and place them in a folder that you can access with you command line of choice. Open the folder and run the downloaded executable with the commands stated below.

Examples

Help: GoGEM or GoGEM --help

A help message will be displayed if you run the tool without or with wrong input.

Upload: GoGEM upload -u "[Username]" -y [year] -t "[Teamname]" -w "[WP URL]" -o "[offset]"

This is the all-in-one command. It downloads your WordPress Page, uploads all the media files, replaces all the links and then uploads all the pages.

Save your WP Page locally: GoGEM fetchWP [URL]

Purge: GoGEM purge -u "[Username]" -y [Wiki Year] -t "[Teamname]" -o "[Offset]"

Purge overwrites all pages in the defined subspace with an empty one.

You will get a list with deleted pages beforehand and will have to enter your password a second time. BE SURE YOU KNOW WHAT THIS DOES BEFORE USING!

Issues

Please report Issues to this repo (https://github.com/Jackd4w/GoGEM), this is where the development will continue.

Contribution

I tried to comment the code reasonably. Please try writing verbose comments when contributing, as this is intended to be a project a beginner programmer can understand. As stated above development will only be continued on this repo (https://github.com/Jackd4w/GoGEM).

Documentation

Overview

Copyright © 2021 Kai Kabuth <kai.kabuth@stud.tu-darmstadt.de>

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.