Check Run Installation Guide

Developer Setup

First, set up a new bench and substitute a path to the python version to use. Python should be 3.8 latest for V13 and 3.10 latest for V14. These instructions use pyenv for managing environments.

# Version 13
bench init --frappe-branch version-13 {{ bench name }} --python ~/.pyenv/versions/3.8.12/bin/python3

# Version 14
bench init --frappe-branch version-14 {{ bench name }} --python ~/.pyenv/versions/3.10.3/bin/python3

Create a new site in that bench

cd {{ bench name }}
bench new-site {{ site name }} --force --db-name {{ site name }}

Download the ERPNext app

# Version 13
bench get-app erpnext --branch version-13

# Version 14
bench get-app payments
bench get-app erpnext --branch version-14
bench get-app hrms

Download the Check Run application

bench get-app check_run [email protected]:agritheory/check_run.git 

Install the apps to your site

bench --site {{ site name }} install-app erpnext hrms check_run

# Optional: Check that all apps installed on your site
bench --site {{ site name }} list-apps

Set developer mode in site_config.json

nano sites/{{ site name }}/site_config.json
# Add this line:
  "developer_mode": 1,

Add the site to your computer's hosts file to be able to access it via: http://{{ site name }}:[8000]. You'll need to enter your root password to allow your command line application to make edits to this file.

bench --site {{site name}} add-to-hosts

Launch your bench (note you should be using Node.js v14 for a Version 13 bench and Node.js v16 for a Version 14 bench)

bench start

Optional: install a demo Company and its data to test the Check Run module's functionality

bench execute 'check_run.tests.setup.before_test'