LEARN, DEPLOY AND CONTRIBUTE
Find the product documentation for restaurant staff, operators and developers. Start with an evaluation, plan a persistent installation and explore the implementation behind each workflow.
CHOOSE YOUR NEXT STEP
01 — GETTING STARTED
Read the product README, check the Node.js requirements and use the temporary in-memory mode for a disposable evaluation. Walk through orders, preparation, payment recording and reports without putting restaurant data at risk.
02 — GETTING STARTED
Choose a restaurant server, persistent PostgreSQL storage and a stable LAN address. Check browser access from each station and verify the physical output from your actual printers.
03 — GETTING STARTED
Create named accounts, replace bootstrap access, review permissions and menu configuration, and establish tested backup and restore procedures. Confirm responsibility for updates, network security and recovery.
The guides below describe the RestaurantPOS application. This public site has its own source, dependencies, deployment and environment. A local product installation runs the Node.js application and PostgreSQL; a browser at each restaurant station connects to that server.
Read the product READMEPRODUCT DOCUMENTATION
Read the operational guide first, then use the focused documents for deployment and configuration. Check instructions against the product version you are evaluating.
Day-to-day workflows for staff and managers.
Local-network design and application boundaries.
Server, PostgreSQL, firewall and device planning.
Menu synchronization setup and diagnostics.
Workbook rules, validation and confirmation.
Product billing calculations, discounts and tax.
Documented permissions; see the user guide for expanded role coverage.
Review the source of truth for product implementation.
CONTRIBUTING TO SYM POS
You can help by reporting reproducible issues, suggesting practical restaurant improvements, reviewing code or contributing a focused change. Follow the current repository guidance when participating.
Include the product version, deployment mode, steps to reproduce and the expected result. Remove customer records, credentials and sensitive infrastructure information from logs or screenshots.
Explain the restaurant workflow you want to change and why it matters. Review current implementation and existing issues before proposing a new feature.
Use the repository’s development and test instructions, keep changes focused and explain behavior and validation in a pull request. Follow any contribution guidance available in the repository.
A GitHub star helps other restaurant operators and developers discover SYM POS. There is no account or star requirement to read this site or explore the source.
OPEN SOURCE. BUILT IN THE OPEN.
SYM POS is an open-source restaurant operations project. Explore the implementation, follow its development and use the documentation to evaluate a local installation. If it’s useful to you, give the project a star on GitHub.
OPEN SOURCE FOR RESTAURANT OPERATIONS
Start with the source and documentation. Contact us for help with a local installation, workflow configuration or custom development.