-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: move installation instructions to doc page, link to that in README
- Loading branch information
1 parent
fc4db1c
commit 427f4ae
Showing
2 changed files
with
70 additions
and
67 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,70 +6,4 @@ MIT | |
|
||
### Installation Instructions | ||
|
||
#### Production Environment | ||
To install this app in a production environment | ||
|
||
```shell | ||
# TO COME | ||
``` | ||
|
||
#### Developer setup | ||
Set up a new bench, substitute a path to the python version to use, which should be 3.8 latest for V13 and 3.10 latest for V14. These instructions use [pyenv](https://github.com/pyenv/pyenv) for managing environments. | ||
|
||
```shell | ||
# 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 | ||
```shell | ||
cd {{ bench name }} | ||
bench new-site {{ site name }} --force --db-name {{ site name }} | ||
``` | ||
|
||
Download the ERPNext app | ||
```shell | ||
# Version 13 | ||
bench get-app erpnext --branch version-13 | ||
|
||
# Version 14 | ||
bench get-app erpnext --branch version-14 | ||
``` | ||
|
||
Download this application | ||
```shell | ||
bench get-app check_run [email protected]:agritheory/check_run.git | ||
``` | ||
|
||
Install the apps to your site | ||
```shell | ||
bench --site {{site name}} install-app erpnext check_run | ||
|
||
# Optional: Check that all apps installed on your site | ||
bench --site {{ site name }} list-apps | ||
``` | ||
|
||
Set developer mode in `site_config.json` | ||
```shell | ||
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. | ||
```shell | ||
bench --site {{site name}} add-to-hosts | ||
``` | ||
|
||
Launch your bench | ||
```shell | ||
bench start | ||
``` | ||
|
||
Optional: install a demo Company and its data to test the Check Run module's functionality | ||
```shell | ||
bench execute 'check_run.test_setup.before_test' | ||
``` | ||
See the [installation guide](./docs/version-13/installationguide.md) for detailed instructions for either a production or development environment. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
# Check Run Installation Guide | ||
|
||
## Production Environment | ||
To install this app in a production environment | ||
|
||
```shell | ||
# TO COME | ||
``` | ||
|
||
## 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](https://github.com/pyenv/pyenv) for managing environments. | ||
|
||
```shell | ||
# 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 | ||
```shell | ||
cd {{ bench name }} | ||
bench new-site {{ site name }} --force --db-name {{ site name }} | ||
``` | ||
|
||
Download the ERPNext app | ||
```shell | ||
# Version 13 | ||
bench get-app erpnext --branch version-13 | ||
|
||
# Version 14 | ||
bench get-app erpnext --branch version-14 | ||
``` | ||
|
||
Download the Check Run application | ||
```shell | ||
bench get-app check_run [email protected]:agritheory/check_run.git | ||
``` | ||
|
||
Install the apps to your site | ||
```shell | ||
bench --site {{site name}} install-app erpnext check_run | ||
|
||
# Optional: Check that all apps installed on your site | ||
bench --site {{ site name }} list-apps | ||
``` | ||
|
||
Set developer mode in `site_config.json` | ||
```shell | ||
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. | ||
```shell | ||
bench --site {{site name}} add-to-hosts | ||
``` | ||
|
||
Launch your bench | ||
```shell | ||
bench start | ||
``` | ||
|
||
Optional: install a demo Company and its data to test the Check Run module's functionality | ||
```shell | ||
bench execute 'check_run.test_setup.before_test' | ||
``` |