nsinnovations/ns_erpnext_app
2
0
Fork 0
Code Issues 3 Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add architecture, design spec, and security notes

Browse Source 
Analyze the NS App and document what it does: NMI card payments on
Sales Invoices, AutoPay vaulting, multi-invoice settlement, guided
Customer Quick Entry, and branded print formats.

- docs/ARCHITECTURE.md  — functional overview, component map, payment
  flow, data model, dependencies, config, known tech debt
- docs/DESIGN_SPEC.md   — goals, requirements, API contracts, failure
  modes, acceptance criteria
- docs/SECURITY_NOTES.md — posture + hardening list
- docs/README.md        — docs index; link from root README

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
norman
2026-07-02 07:33:32 -04:00
parent 4e0acde164
commit 8bb8954ff6
5 changed files with 496 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -11,6 +11,13 @@ Storing the returned vault ID on the ERPNext Customer for future autopay use
This part of the app is designed to integrate directly into the Sales Invoice workflow.
Documentation
Full reference docs live in the docs/ folder:
- docs/ARCHITECTURE.md – what the app does, components, payment flow, data model
- docs/DESIGN_SPEC.md – requirements, API contracts, failure modes, acceptance criteria
- docs/SECURITY_NOTES.md – security posture and hardening list
Features
Secure card entry using NMI Collect.js (tokenization)
Manual payment dialog inside ERPNext