Skip to content

Latest commit

 

History

History
 
 

README.md

POS Next Documentation

Welcome to the POS Next documentation directory. This folder contains comprehensive guides for developers and contributors.

📚 Available Documentation

User Guides

  • LOCALIZATION.md - Language settings guide

    • Configuring allowed languages
    • Using the language switcher
    • Available languages
    • Troubleshooting
  • Wallet-Loyalty-User-Guide.md - Wallet and loyalty system user guide

  • OFFERS_AND_PROMOTIONS.md - Offers and promotions system

    • Pricing Rules and Promotional Schemes integration
    • Mixed Conditions configuration
    • Frontend architecture (stores, flow)
    • Backend API reference
    • Troubleshooting guide

Architecture

  • STARTUP_SEQUENCE.md - Application initialization flow

    • PWA service worker registration
    • Parallel authentication (CSRF + User)
    • Bootstrap data preloading
    • Performance optimizations
    • Offline worker integration
  • OFFLINE_SYNC.md - Offline invoice synchronization system

    • Architecture overview
    • Deduplication mechanism (offline_id)
    • Data flow diagrams
    • API reference
    • IndexedDB schema
    • Troubleshooting guide

Version Control

  • VERSION_CONTROL.md - Complete guide to the version control system

    • Architecture overview
    • Version types and strategies
    • Build process details
    • Release procedures
    • API reference
    • Troubleshooting
  • QUICKSTART_VERSION.md - Quick reference for version management

    • Common commands
    • Quick workflows
    • File locations
    • Troubleshooting tips

🚀 Quick Links

For Developers

Check current version:

cd /home/ubuntu/frappe-bench
bench --site nexus.local execute pos_next.utils.get_app_version

Bump version:

cd /home/ubuntu/frappe-bench/apps/pos_next
./scripts/version-bump.sh patch  # or minor/major

Build frontend:

cd POS
yarn build

For Contributors

📝 Documentation Structure

docs/
├── README.md                        # This file
├── LOCALIZATION.md                  # Language settings user guide
├── OFFERS_AND_PROMOTIONS.md         # Offers and promotions system
├── OFFLINE_SYNC.md                  # Offline invoice sync system
├── STARTUP_SEQUENCE.md              # Application initialization flow
├── VERSION_CONTROL.md               # Comprehensive version control guide
├── QUICKSTART_VERSION.md            # Quick reference guide
├── Wallet-System-Technical-Guide.md # Wallet system technical docs
└── Wallet-Loyalty-User-Guide.md     # Wallet and loyalty user guide

🔗 External Resources

📧 Support

For questions or issues:

🤝 Contributing

When adding new documentation:

  1. Place .md files in this docs/ folder
  2. Update this README with links to new docs
  3. Follow the existing documentation style
  4. Include code examples where appropriate
  5. Add troubleshooting sections