Skip to content

Latest commit

 

History

History
118 lines (92 loc) · 6.59 KB

README.md

File metadata and controls

118 lines (92 loc) · 6.59 KB
Raw

Scrutinizer Code Quality Crowdin Travis CI Build codecov Mattermost

Opencaching.de Code Repository

Opencaching.de is a major Geocaching website in Germany. This repository contains the website's code, including all third-party libraries needed to run it. It is one of two major Opencaching code forks; the other one is Opencaching.pl. Feel free to use it under the provided license terms for setting up your own open and free Geocaching listing service! The code can easily be translated to other languages.

Your contributions to this project are welcome - you may contact the team in the Mattermost Channel or Opencaching.de forum if you like to join us. Development is usually done on a VirtualBox Linux system that you can run on your Linux, Windows or Mac workstation, but you may also try to set up the code directly on your Linux machine. Otherwise you can use our new vagrant box. You get the needed link from a Team Member in Opencaching.de forum or you start with our new minimal dump.

In the Vagrant System our example login for the opencaching platform ist root with the password developer.

This repo contains three branches:

  • the stable branch with current opencaching.de production code
  • the development branch, basis of all development, which contains code that will be released with the next site update
  • the next branch with experimental features to be tested.

The next branch is now and then resetted to development state and rebuilt from there, so do not derive any working-branches from it. Use development instead.

Major OC.de site updates are version-tagged. See the changelog for a detailed list.

Translation Crowdin

This Project uses crowdin to translate all words and strings in the code. It starts with Version 3.0.19 of this code. We are looking for native speakers who will help to translate. There is a review process wich needs at least two translators to validate the translation of each other. To join the translation team - use this invitation url: (https://crowdin.com/project/opencaching/invite)

Sponsoring Technology Partner

We thank our technology partners for their support of our open source project!

Starting the docker development environment

  1. Start a terminal and run ./psh.phar docker:start in the project root
  2. Start a new terminal
    • Run ./psh.phar docker:ssh and ./psh.phar docker:init
  3. Open your browser and visit the following URL: http://docker.team-opencaching.de

NOTE: New Version of Opencaching will be called "OC4". We decide to setup a new temporary URL: http://try.docker.team-opencaching.de and we generate a new administration section at http://try.docker.team-opencaching.de/backend. Use root:developer to login.

Contributions

Contributing code to Opencaching.de is easy:

  • Sign up to Github and install Git,
  • create a personal fork of this repository using the Fork button above,
  • clone the fork to your development machine,
  • create a feature branch based on development,
  • edit and commit code,
  • push your feature branch to your fork and issue a pull request.

Your code will be reviewed, eventually merged to development and put online with the next site update. Small changes may be directly released via stable branch.

To update your working copy, add this repo as upstream ...

git remote add upstream https://github.com/OpencachingDeutschland/oc-server3.git

... and regularly update your clone:

git checkout development
git pull upstream

NEVER use pull on a feature branch, but pull to development and then rebase the feature branch on development:

git checkout feature-branch
git pull --rebase upstream/development

Related Websites