Setting up OLE using Github

The information below pertains to developers and other coding enthusiasts who would like to set up a running instance of the Open Library Environment project from Github.

Step-by-step guide

1. Checkout OLE code from github
   1. Create a local workspace where you would want to checkout the OLE codebase
   2. clone the remote repository by issuing the following command: git clone https://github.com/openlibraryenvironment/ole.git
   3. Once its cloned, you will see a folder with the name "ole" created. 
2. Switch to the appropriate branch
   1. Check which branch is active in your local repository by issuing the following command: git branch -a
      1. One of the listed entries should have an * next to it indicating that is the active branch currently on your local box.
   2. You will need to switch to the "develop" branch. As a best practice, we push our changes to the develop branch.
      1. Issue the following command to switch to the develop branch: git checkout develop
3. Launch your favorite IDE and start OLE (IntelliJ IDEA instructions- coming soon!)
4. Ongoing Development
   1. Fork your copy
   2. Make changes to your local copy
   3. Push changes to your forked repository
   4. Create a pull request
5. Core Committers
   1. Review pull requests
      1. Direct Diff
      2. Fetch changes locally
         1. Review
         2. Merge
         3. Push

Related articles

• Page:
  OLE development using Github
• Page:
  OLE Git workflow