HOW-TO check out PKP applications from git

From PKP Wiki
Revision as of 12:20, 2 August 2013 by Alec (Talk | contribs) (Check out the application(s) on your local machine)

Jump to: navigation, search


This is the official process to check out OMP with the PKP library as a sub-module. The same process applies to all other PKP projects. Just exchange omp for ojs, ocs or harvester.

Create user

This tutorial assumes that you'll work with forked copies of our software on github and that you intend to publish your changes back. You can do without forks, especially if you want to have only read access. You'll have to adapt this process a bit then (e.g. exchange the read/write URLs to forks with read-only URLs to the master repository). Please refer to the git documentation for this.

If you want write access to the repository then go to and create your own user account there and log into it. See the github documentation to generate/add your RSA key to your github account.

If you want to write back to the official PKP git repositories then you'll need write access there. Please ask Juan or Florian to grant you access.

Delete existing personal forks

First you have to delete existing personal forks of omp/pkp-lib if you have cloned these repositories before. You obviously shouldn't do this when there are still changes in there you don't have in other locations! If you don't have existing forks then you can jump to the next step.

Otherwise do the following:

  • Go to your personal github dashboard.
  • In "Your Repositories" select the forks you want to delete.
  • Go to Admin tab.
  • Down on the page click on "Delete This Repository".
  • Repeat these steps for both omp and pkp-lib

Fork the official application repositories

You can fork a subset of these projects if you do not intend to work on all of them. You'll always need the pkp-lib repository together with any of the application-specific repositories.

Check out the application(s) on your local machine

Use the shell script to check out each application that you wish to work on:

bash your-user ojs ojs-checkout

In the above example, "your-user" is your username. It will check the "ojs" application out into a directory called "ojs-checkout".

Where to go from here?

Have a look at frequent git use cases for typical git use cases you'll encounter in your day to day work with git.


"Git cheat sheet"