Shipyard Custom

Shipyard operations and Job Order management app for ERPNext.

Installation

You can install this app using the bench CLI:

cd $PATH_TO_YOUR_BENCH
bench get-app $URL_OF_THIS_REPO --branch main
bench setup requirements
./env/bin/python -c "import shipyard_custom; print(shipyard_custom.__file__)"
bench --site $SITE_NAME install-app shipyard_custom
bench --site $SITE_NAME migrate
bench build --app shipyard_custom
bench --site $SITE_NAME clear-cache
bench restart

Install ERPNext on the site before installing this app. shipyard_custom declares ERPNext as a required app because it extends ERPNext doctypes such as Quotation, Stock Entry, Timesheet, Project, and Sales Invoice.

For Docker production, run the get-app and bench setup requirements steps in the image/container that serves web requests. If import shipyard_custom fails, the app is cloned but not installed into the Python environment, and Frappe will raise ModuleNotFoundError: No module named 'shipyard_custom'.

Contributing

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

cd apps/shipyard_custom
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