ERPnext Engineering Module

Open Source, modern, and easy-to-use Engineering Software for ERPnext

Engineering

Engineering module to provide advanced fucntionalities and custom configurations for engineering teams.

Functionalities

• Item Coding Standard table
• Item coding based on Item Coding Standard
• Item Revisions

Installation

After installing frappe-bench on your machine and setting up your DNS follow the guide below to prepare your production or your development environment. Testing environement will be added in a later stage.

Production

SITE=sitename
bench new-site $SITE

1. Install Engineering Module for ERPnext You can install this app using the bench CLI:

PATH_TO_YOUR_BENCH="~/frappe-bench/"
URL_OF_THIS_REPO="git@github.com:teodoropiccinni/erpnext_engineering.git"
VERSION_OF_FRAPPE="version-15"
APP_NAME="erpnext_engineering"
echo "Moving to folder: $PATH_TO_YOUR_BENCH"
cd $PATH_TO_YOUR_BENCH
echo "Bench get-app $APP_NAME"
bench get-app $URL_OF_THIS_REPO --branch $VERSION_OF_FRAPPE
echo "Moving to app folder"
cd apps/$APP_NAME
echo "GIT pull"
git pull
echo "GIT submodule init"
git submodule init
echo "GIT pull --recurse-submodules"
git pull --recurse-submodules
echo "Bench install-app $APP_NAME"
bench --site $SITE install-app $APP_NAME

Where $PATH_TO_YOUR_BENCH is usually: ~/frappe-bench/ and version-15 is the current version. Adapt those parameters to your needs.

2. Disable developer mode

bench --site yoursite set-config -g developer_mode 0

3. Enable HTTPS

   1. Enable DNS based multitenancy

bench config dns_multitenant on
sudo service nginx reload

1. Install Certbot

https://certbot.eff.org/instructions?ws=nginx&os=pip

1. 

Development

SITE=sitename
bench new-site $SITE

1. Install Engineering Module for ERPnext You can install this app using the bench CLI:

PATH_TO_YOUR_BENCH="~/frappe-bench/"
URL_OF_THIS_REPO="git@github.com:teodoropiccinni/erpnext_engineering.git"
VERSION_OF_FRAPPE="develop-15"
APP_NAME="erpnext_engineering"
echo "Moving to folder: $PATH_TO_YOUR_BENCH"
cd $PATH_TO_YOUR_BENCH
echo "Bench get-app $APP_NAME"
bench get-app $URL_OF_THIS_REPO --branch $VERSION_OF_FRAPPE
echo "Moving to app folder"
cd apps/$APP_NAME
echo "GIT pull"
git pull
echo "GIT submodule init"
git submodule init
echo "GIT pull --recurse-submodules"
git pull --recurse-submodules
echo "Bench install-app $APP_NAME"
bench --site $SITE install-app $APP_NAME

Where $PATH_TO_YOUR_BENCH is usually: ~/frappe-bench/ and version-15 is the current version. Adapt those parameters to your needs.

2. Enable developer mode

bench --site yoursite set-config -g developer_mode 1

ERPnext configurations

Contributing

This app uses pre-commit for code formatting and linting. Please install pre-commit and enable it for this repository:

cd apps/erpnext_engineering
pre-commit install

Pre-commit is configured to use the following tools for checking and formatting your code:

• ruff
• eslint
• prettier
• pyupgrade

CI

This app can use GitHub Actions for CI. The following workflows are configured:

• CI: Installs this app and runs unit tests on every push to develop branch.
• Linters: Runs Frappe Semgrep Rules and pip-audit on every pull request.

License

mit

External resources

• Installation:

• Enable HTTPS: https://docs.frappe.io/framework/user/en/bench/guides/configuring-https

• Server Script API:

• Client Script API: https://docs.frappe.io/framework/user/en/api/form

• Icons: https://primer.github.io/octicons/