Home

Developing webERP - maintaining a fork and submitting improvements

First Create Your Personal Fork of webERP

To create a fork of webERP for use in your business and to keep track of your changes (and potentially give improved code back to webERP) you first create your own GitHub login - then browse back to:

https://github.com/webERP-team/webERP

Click the fork button as show below:

The fork creates a copy of the webERP repository as it is now to your own repository.

Making your own changes

If your GitHub login is "JoeCool" then browse to your GitHub page:

http://github.com/JoeCool

Click on your webERP repository that you created in the first step above, and then click on the "Clone/Download" button and then click the copy button to copy the URL to your repository.

Now on your development machine (with git installed) in a terminal window change to the directory where you wish to create the working copy of your webERP repository for development. It makes sense to have the webERP code under your web-root directory so that you can test any changes you make in a browser on the same machine with http://localhost/webERP - e.g. My web-root directory is /var/www/html

I had to add my user phil to the www-data group (your web-server user group may be different) and then add permissions to the downloaded files to allow the members of the group to have write access. (sudo chmod -R g+w webERP)

Then to clone the webERP git repository to this directory, at the Linux command line use the git command:

$git clone https://github.com/PhilDaintree/webERP.git

This downloads the git repository and makes a working copy on your machine under the current directory.

Getting updated code from webERP-team/webERP repository into your forked repository

When webERP developers add new functionality to the code you can keep your fork in sync with the webERP code by fetching the latest webERP code and merging back into your code. GitHub reports on your fork if there have been commits to the webERP-team/webERP/master repository from which your fork was created in the GitHub web interface.

To get the latest changes/commits, at the Linux command line use the git command:

$git remote add upstream https://github.com/webERP-team/webERP.git

The "add upstream" command only needs to be done once to make the upstream repository the webERP-team/webERP repository.

Then whenever you wish to get the latest webERP-team/webERP bug fixes/new developments, at the Linux command line use the git command:

$git fetch upstream

The newly fetched code then has to be merged with the code in your repository/branch - assuming your branch is called master to perform the merge, at the Linux command line use the git command:

$git merge upstream/master