Mail: [email protected]
Phone: +1(628) 800-7750
Documentation
Everything you need to know about NexoPOS.
- Getting Started
- 0. Requirements
- 1. The Environment
- 2. Download And Build
- 3. Installation Wizard
- Components
- Accounting: Incomes & Expenses
- Cash Registers
- Customers
- Customers Group
- Expense History
- Expenses
- Expenses Categories
- Media
- Modules
- Numpad
- Order Types
- Orders
- Payment Types
- Procurements
- Product Categories
- Products
- Providers
- Reward System
- Stock Adjustment
- Table
- Taxes
- Taxes Groups
- Unit Groups
- Units Of Measure
- Base API
- Dashboard Widgets
- Hook System
- Role & Permissions
- NsMultiStore Api
- Make Jobs MultiStore Compatible
- Register Web & API Routes For MultiStore
- Updating Migrations
- Filters
- {namespace}-bulk
- {namespace}-catch-action
- {namespace}-crud-actions
- Filter : ns-views:pages.sign-in
- Filter : ns-views:pages.sign-up
- ns-crud-resource
- ns-dashboard-menus
- ns-footer-signature
- ns-page-title
- ns-products-crud-form
- ns-products-history-operation
- ns-products-type
- ns-table-name
- ns-web-receipt-template
- How To's
- Changing Domain
- Checkout Popup
- Database Configuration
- Email Configuration
- Enable Low Stock Notification
- Installing And Updating A Module
- Installing NexoPOS 4.x On Laragon
- Installing NexoPOS 4.x On Plesk
- Installing NexoPOS 4.x Using The cPanel
- Installing NexoPOS On Hostinger
- Link Nexo Print Server To NexoPOS 4.x
- Local Network Configuration
- Manage Customers On The POS
- Manage Sales Refunds
- Manual Module Installation
- Orders With Instalments
- Rebranding NexoPOS 4.x
- Translating NexoPOS
- Updating NexoPOS 4.x
- Using The Sales Filter
- Javascript API
- nsHttpClient
- nsNotice
- nsSnackBar
- Actions
- ns-dashboard-footer
- ns-dashboard-pos-footer
- My NexoPOS
- Assign Print Jobs
- Cloud Print Setups
- Creating My NexoPOS Clients
- Deactivating Nexo Print Server 2.6 License
- Linking My NexoPOS To Envato
- Nexo Print Server 2.6.x License Validation
- NexoPOS 3.x License Validation
- Developpers Guides
- Add Crud Entry Custom Action
- Creating A Sample Hello World Page
- Creating Crud Components
- Creating Custom Pages
- Creating Custom Print Handler
- Creating Settings Page
- Dashboard Theming
- Database Migration
- Generating Modules
- Handle Crud Actions Using JavaScript
- Injecting Vue Component
- Model's Dependency
- Module's config.xml File
- Module's Routing
- Register Dashboard Menus
- Render Field As Vue Component
- Reset User Password With Tinker
- Service Provider
- Troubleshooting
- Broken Media Images
- Common Database Issues
- Conflicting Dashboard
- CSRF Token Mismatch On NexoPOS 4.x
- Disabling Modules Manually
- Environment Misconfiguration
- Images Not Loading
- No Dashboard
- No Default Customer
- Products Not Appearing For Sale
- Products Not Showing On The POS
- Using Nexo Print Server With SSL
- Workers Or Async Requests Disabled
- Gastro Guides
- Managing Modifiers
- Crud API
- Add Crud Entry Custom Action
- Creating Crud Components
- Declare Custom Crud Export Columns
- Handle Crud Actions Using JavaScript
- Header Buttons
- Nexo Print Server
- Configuration
0. Requirements
Before considering installing NexoPOS 4.x let's table a little bit about what are the requirements. This section will cover the requirements in terms of knowledge to the requirements in terms of hosting.
What You Need To Know
How the CLI works
Before considering installing NexoPOS, we believe you know how to install Laravel. This means you should be familiar with the CLI (Command Line Interface) which is mostly used to install NexoPOS.
How Git Works
You also need to be familiar with Git, which is used to deploy and update NexoPOS.
How Composer Works
Composer is used to install NexoPOS dependencies. Knowing the basics here is fairly enough. For further instructions, you can find these on the composer website.
How to be patient
NexoPOS installation might take some time or not according to whether your server is configured or not. For an empty server, the configuration + the installation might take up to 30 minutes. When everything is set up, the installation might take up to 10 minutes.
In case you have some issues during the installation, there are two options that are available for you :
- Contact us if you have purchased NexoPOS on CodeCanyon
- Post an Issue on Github to receive free support.
Hosting Requirement
NexoPOS shouldn't be installed on shared hosting. This absolutely unadvised. In order to use all the features of NexoPOS without worrying about performance, you're invited to use a server with at least 2 GB of ram. There are many providers available out there who can be used :
Vultr
Vultr is a popular Cloud Hosting provider. We've currently hosted our applications using this provider. They have a quite reliable server availability. They are also over cheap servers with various stacks.
Digital Ocean
Same as Vultr, Digital is a well-known Cloud Hosting provider that has many plans with various instances specifications. Their dashboard might look intimidating for a beginner, but it's also really easy to use.
Linode
Linode is one of the most popular providing affordable cloud hosting and various other hosting services. Getting started with this provider is as easy as it is for Digital Ocean and Vultr.
Resources Requirements
Not every NexoPOS installation might have the same needs in terms of resources. If you're planning to use a regular installation, your needs will be less than if you have premium extensions on your system. This table shows the recommended resources considering the modules you might use.
| Module | Ram | Storage |
|---|---|---|
| NexoPOS | 1GB | 10GB |
| Gastro + NexoPOS | 2GB | 20GB |
| Multistore + NexoPOS | 4GB | 30GB |
| Gastro + MultiStore + NexoPOS | 8GB | 120GB |
Only those modules were included as we believe they add an extra load on a server. The other module won't have a significant impact on your server performance.