a-gundy / door43 Goto Github PK

This repo is our unified DokuWiki + plugins repo.

1. Fork this Door43 repo into your own GitHub account with the Fork button at the top of https://github.com/unfoldingWord-dev/Door43

2. Clone your forked copy of Door43 onto your machine

   git clone [email protected]:<username>/Door43.git
   

3. Update your web server to have a virtual host that points to the Door43 directory. (If you instead have Door43 as a subdirectory in your main web root directory, you will need to change the RewriteBase in the .htaccess file and then run this command so it doesn't commit it to the repo: git update-index --assume-unchanged .htaccess)

4. Make sure you are on the development branch:

   git checkout development
   

5. Make sure that your web server's process has write access to the conf and data directories and all files and subdirectories.

   Example:

   cd Door43
   chown -R www.www .
   or
   chmod -R a+rw .
   

6. Run the door43_bootstrap.sh Bootstrap script. (You will need to be working on a Linux box or through Git Bash shell on Windows)

   cd Door43
   ./door43_bootstrap.sh
   

   (install language repos when prompted)

7. You can now go to http://<your.door43.domain>/home?do=login and login as admin, password admin.

• You can add more language repos to your Door43 this way:

  cd Door43
  ./install_languages.sh <IETF Language Code(s)>
  

  Example (installs Chinese and French):

  ./install_languages.sh zh fr
  

• Be sure to keep them updated: (Will update all installed language repos)

  cd Door43
  ./update_languages.sh
  

• If you ever want to update your Door43 installation, run the following:

  (Will update Door43 repo, Submodule repos and language repos)

  cd Door43
  ./door43_update.sh
  

General instructions for unit testing in Dokuwiki can be found here.

Instruction for writing PHPUnit tests can be found on the PHPUnit website.

IMPORTANT: You should use extends DokuWikiTest instead of extends PHPUnit_Framework_TestCase when creating new test cases. For examples, see the files in the _test/tests/test directory.

Each code change should be accompanied by unit tests that show the feature is working correctly. Run all unit tests before you submit a pull request to be sure all tests are passing. If a test is not passing, you need to figure out if something you did broke the test and fix it.