diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 5e95e884245..0c96641c4c1 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,5 +1,5 @@ ## Overview -_A brief description of the pull request. Try to keep it non-technical. Please mark your pull request with the appropriate [label(s)](https://github.com/civicrm/civihr/blob/staging/CONTRIBUTING.md#label-types)_ +_A brief description of the pull request. Try to keep it non-technical. Please mark your pull request with the appropriate [label(s)](https://github.com/compucorp/civihr/blob/staging/CONTRIBUTING.md#label-types)_ ## Before _The current status. Please provide screenshots or gifs ([LICEcap](http://www.cockos.com/licecap/), [SilentCast](https://github.com/colinkeenan/silentcast)) where appropriate._ diff --git a/Jenkinsfile b/Jenkinsfile index ff4df9e64da..58e4a64dc0a 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -374,7 +374,7 @@ def testJS(hrcoreFolder, java.util.LinkedHashMap extension) { def listCivihrGitRepoPath() { return [ [ - 'url': 'https://github.com/civicrm/civihr.git', + 'url': 'https://github.com/compucorp/civihr.git', 'folder': "$CIVICRM_EXT_ROOT/civihr" ], [ diff --git a/README.md b/README.md index 6ae4bb8d00b..38bf090f225 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,9 @@ -CiviHR is a collection of extensions defining a human-resources application -that runs on top of the CiviCRM platform. +[CiviHR](https://civihr.org/) is an open source HR software solution, that runs on top of the CiviCRM platform. See also: * Install: [doc/INSTALL.md](doc/INSTALL.md) - * Upgrade: [doc/UPGRADE.md](doc/UPGRADE.md) - * Develop (install, test, etc): [doc/DEVELOP.md](doc/DEVELOP.md) - * Wiki: http://wiki.civicrm.org/confluence/display/HR/CiviHR - * Issues: http://issues.civicrm.org/jira/secure/Dashboard.jspa?selectPageId=11213 + * User Guide: http://civihr-documentation.readthedocs.io/en/latest/ + * Demo site: https://demo.civihrhosting.co.uk/ We are using browserstack for testing: diff --git a/doc/DEVELOP.md b/doc/DEVELOP.md deleted file mode 100644 index cc141485efb..00000000000 --- a/doc/DEVELOP.md +++ /dev/null @@ -1,106 +0,0 @@ -## Download - -Clone this git repository, e.g. - -```bash -cd /var/www/drupal/sites/all/modules/civicrm -mkdir -p tools/extensions -git clone git://github.com/civicrm/civihr.git tools/extensions/civihr -``` - -## Install - -If you have Drush installed, then you can enable all the extensions at once: - -```bash -cd /var/www/drupal -bash sites/all/modules/civicrm/tools/extensions/civihr/bin/drush-install.sh --with-sample-data -``` - -If you're familiar with different ways to call drush, then you can use the same -techniques with drush-install.sh, e.g. - -```bash -cd /var/www/drupal/sites/all/modules/civicrm/tools/extensions/civihr -./bin/drush-install.sh --with-sample-data --root=/var/www/drupal - -or - -cd /var/www/drupal/sites/example.com -bash /var/www/drupal/sites/all/modules/civicrm/tools/extensions/civihr/bin/drush-install.sh --with-sample-data -``` - -Read the drush-install.sh for details. - -## Schema development - -Most CiviHR extensions define their schema using CiviCRM's custom-data system. -During installation, modules using this sytem will load "xml/auto_install.xml" -which was [re]generated using the command "civix generate:custom-xml". -(Note: The XML won't be reloaded during upgrade. To support upgrades, one must -add an upgrade_N() function to CRM/*/Upgrader.php.) - -The hrjob extension uses XML/GenCode to manage schema. When modifying the -schema, be sure to: - - 1. Edit the XML files in "hrjob/xml/schema/CRM/HRJob" - 2. Run the command "hrjob/bin/setup.sh {CIVICRM_ROOT}" - 3. Manually copy relevant SQL snippets from "{CIVICRM_ROOT}/sql/civicrm.mysql" to "hrjob/sql/auto_install.sql" - 4. (If appropriate) Add an upgrade_N() function to hrjob/CRM/HRJob/Upgrader.php - -## Test - -To run the unit-tests, one must configure CiviCRM to run unit-tests, install -cv, and populate the cv vars file. To do that, run: - -```bash -$ cv vars:fill -Site: /path/to/your/installation/sites/default/civicrm.settings.php -These fields were missing. Setting defaults: -{ - "ADMIN_EMAIL": "admin@example.com", - "ADMIN_PASS": "t0ps3cr3t", - "ADMIN_USER": "admin", - "CMS_TITLE": "Untitled installation", - "DEMO_EMAIL": "demo@example.com", - "DEMO_PASS": "t0ps3cr3t", - "DEMO_USER": "demo", - "SITE_TOKEN": "38022b28355040d28e1f6dd2f7248b96", - "TEST_DB_DSN": "mysql://dbUser:dbPass@dbHost/dbName?new_link=true" -} -Please edit /home/user/.cv.json -``` - -As the command output suggests, you need to edit "~/.cv.json" with your installation ADMIN_PASS, DEMO_PASS -and TEST_DB_DSN. You'll also need to add the "CMS_URL" option with the URL of you installation. - -To execute particular tests, use "phpunit4": - -```bash -user@host:/path/to/civihr/hrjob$ phpunit4 tests/phpunit/api/v3/HRJobTest.php -Adding Individual -Adding Organization -PHPUnit 4.8.21 by Sebastian Bergmann. - -. -Installing civicrm_tests_dev database - - -Time: 24 seconds, Memory: 28.25Mb - -OK (1 test, 4 assertions) -``` - -To run all the tests for an extension, just run "phpunit4" without passing the test file: - -```bash -user@host:/path/to/civihr/hrjob$ phpunit4 -``` - -(Note: We're assuming that there are two databases. The "live database", -used with "civix civicrm:ping", which is part of a fully-functioning CiviCRM/CiviHR installation. -The "headless testing database" is, which is the one you configured in the "TEST_DB_DSN" option -of the ~/.cv.json file.) - -(Note: For "hrjob", there's an extra pre-requisite: before running tests, run -"hrjob/bin/setup.sh {CIVICRM_ROOT}".) diff --git a/doc/INSTALL.md b/doc/INSTALL.md index 5a08e8cd78d..f58606fcc40 100644 --- a/doc/INSTALL.md +++ b/doc/INSTALL.md @@ -1,74 +1,19 @@ -## Pre-requisites +# Introduction -CiviCRM 4.5 +CiviHR is a complex system, with many moving parts. The code in this repository is just one of these parts. It's possible to create a new site manually, but, given the number of necessary steps, this a hard and time consuming task. For this reason, the best way to install CiviHR is by using one of the installation methods available: -> NOTE: CiviHR includes some significant changes to the nomal CiviCRM -> user-experience. As with any significant change or addition, CiviHR -> should be evaluated on a test/staging site before installing on a -> live/production site. +## Using the civihr-installer script -## Download +The [civihr-installer](https://github.com/compucorp/civihr-installer) script has a mininum set of requirements and it is a quick way to get CiviHR up and running. Please check its repository for more information on how to use it. -```bash -cd -# (ex: $drupalroot/vendor/civicrm or $civiroot/tools/extensions or a custom-configed path) +> Note: A site created with this script is not suited for development, as it will not include many tools and files required for this kind of work. If you're looking for that, the installation with buildkit is the way to go. -wget https://github.com/civicrm/civihr/archive/1.4.0.zip -unzip 1.4.0.zip -mv civihr-1.4.0 civihr -``` - -> NOTE: On some misconfigured systems, the "wget" command may display a warning -> like "ERROR: The certificate of `github.com' is not trusted." For a workaround, -> add the option "--no-check-certificate" or check out [this article](http://blog.55minutes.com/2012/01/fixing-https-certificate-errors-in-wget-and-ruby/). - -## Install (Option A: Drush) +## Using buildkit -If you have Drush installed, then you can enable all the extensions at once: +[Buildkit](https://github.com/civicrm/civicrm-buildkit) is a collection of development tools for CiviCRM. Among these tools, there's `civibuild`, which can be used to quickly create new sites. To create a new CiviHR site, you can use the `hr17` build type: -```bash -cd /var/www/drupal -bash vendor/civicrm/civihr/bin/drush-install.sh --with-sample-data ``` - -If you're familiar with different ways to call drush, then you can use the same -techniques with drush-install.sh, e.g. - -```bash -cd /var/www/drupal/vendor/civicrm/civihr -./bin/drush-install.sh --with-sample-data --root=/var/www/drupal - -or - -cd /var/www/drupal/sites/example.com -bash /var/www/drupal/vendor/civicrm/civihr/bin/drush-install.sh --with-sample-data +$ civibuild create hr17 ``` -Read the drush-install.sh for details. - -## Install (Option B: Manual) - -CiviHR includes over a dozen extensions. These can be activated piecemeal. -The following extensions provide the major features and may be activated -individually: - - * org.civicrm.hrbank: Bank Details - * org.civicrm.hrcareer: Career History - * org.civicrm.hrdemog: Extended Demographics - * org.civicrm.hremerg: Emergency Contacts - * org.civicrm.hrabsence: Absences - * org.civicrm.hrjobcontract: Job Contracts - * org.civicrm.hrmed: Medical and Disability - * org.civicrm.hrqual: Qualifications - * org.civicrm.hrreport: Reporting - * org.civicrm.hrstaffdir: Staff Directory - * org.civicrm.hrcase: Case - * org.civicrm.hrcaseutils: Case Utils - * org.civicrm.hrim: Instant messanger link - * org.civicrm.hrrecruitment: Recruitment - * org.civicrm.hrprofile: Profile - -Finally, these two extensions build on top of the others: - - * uk.co.compucorp.civicrm.hrsampledata: Generate random example data - * org.civicrm.hrui: Trim/revise CiviCRM UI for CiviHR users +Please check the [civibuild documentation](https://docs.civicrm.org/dev/en/latest/tools/civibuild/) for more information on all the available params. diff --git a/doc/RELEASE.md b/doc/RELEASE.md deleted file mode 100644 index 870000d02e0..00000000000 --- a/doc/RELEASE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Release - -To prepare a new release of CiviHR: - -* Checkout a copy of CiviHR -* Ensure that the working copy is clean and fully up-to-date -* Review/update INSTALL.md and UPGRADE.md -* Update the info.xml files and create a git tag (see bin/git-release.sh) -* Push the updated branch and the new tag -* Review/update the text and links in https://civicrm.org/extensions/civihr -* Review/update the Jenkins job for the demo site(s) diff --git a/doc/UPGRADE.md b/doc/UPGRADE.md deleted file mode 100644 index 98036a88555..00000000000 --- a/doc/UPGRADE.md +++ /dev/null @@ -1,24 +0,0 @@ -## Upgrade: CiviHR (1.3 => 1.4.0) - -> CiviHR 1.4.0 requires CiviCRM 4.5. -> -> If you have an older version of CiviCRM, first upgrade CiviCRM to 4.5 or above. -> (Please follow steps mentioned at: -> http://wiki.civicrm.org/confluence/display/CRMDOC/Upgrade+Drupal+Sites+to+4.5+-+Drupal+7 ) - -Make a backup of the CiviCRM database. - -Download CiviHR 1.4.0: - -``` -cd -(ex: $drupalroot/vendor/civicrm or $civiroot/tools/extensions or a custom-configed path) - -rm -rf civihr -wget https://github.com/civicrm/civihr/archive/1.4.0.zip -unzip 1.4.0.zip -mv civihr-1.4.0 civihr -``` -Goto 'Administer => System Settings => Manage Extension' and click the "Refresh" button. - -Notice the CiviCRM popup alert. Click on "Execute the updates". \ No newline at end of file diff --git a/package.json b/package.json index 364c68001ea..d27c2287dba 100644 --- a/package.json +++ b/package.json @@ -4,10 +4,10 @@ "license": "AGPL-3.0", "repository": { "type": "git", - "url": "https://github.com/civicrm/civihr.git" + "url": "https://github.com/compucorp/civihr.git" }, "bugs": { - "url": "https://github.com/civicrm/civihr/issues" + "url": "https://github.com/compucorp/civihr/issues" }, "scripts": { "precommit": "lint-staged",