Usage
With ShopiTerm installed and configured, it can be used via SSH.
Assuming it is configured as with the default compose file, ShopiTerm listens on port 2222.
ssh localhost -p 2222
Catalogue
After connecting via SSH, you are presented with the item list view showing all available products.
Use ↑ and ↓ to navigate through items.
Press Enter to view the details of a selected item, including its description, price, tags, and a sidebar of similar item recommendations.
Press / to open the search view, where you can type to fuzzy-filter items by name.
Press Esc to return to the previous view.
Cart
Press a to add the currently focused item to your cart.
Navigate to the cart view to see all items you have added.
Use ↑ and ↓ to navigate cart items, and adjust quantities with + and -.
Quantities are capped at the available stock level, so you cannot add more than what is in stock.
Press d or Delete to remove an item from the cart.
Checkout
From the cart view, press Enter to proceed to checkout.
You will be prompted to fill in a shipping address form with fields for street, city, postal code, and country (selected from a list).
An email address is also required for order notifications.
Use Tab to move between fields and Enter to submit the form.
The system validates all fields before allowing you to proceed.
Payment
With the checkout completed, the payment process is being started. As we try to use as much free and open source technology as possible, we opted for GNU Taler as our payment solution. There is no need to enter any payment details. Instead, a QR code will be generated which can be scanned by a Taler wallet. Once paid through Taler, the order is automatically confirmed.
Note
By default,
ShopiTermuses the demo backed hosted by Taler with the KUDOS demo currency. This is already configured in the official Taler mobile wallets for usage.
Adding Items
Admin users (identified by a configured SSH public key) are presented with an admin menu upon connecting. From the admin menu, you can manage items, warehouses, and orders.
To add a new item, navigate to the item list in the admin panel and select the option to create a new item. Fill in the item details such as name, description, and price, then submit. Tags can be added or removed from items to improve catalogue organization and recommendation quality. Stock for each item is managed per warehouse through the warehouse management view.
Order Overview
Admin users can view all placed orders from the admin panel. The order list displays each order with its status (e.g. awaiting payment, paid, shipped). Select an order to view its details, including the ordered items, shipping address, and payment information. From the order detail view, admins can mark an order as shipped, which triggers a shipping confirmation email to the customer.
Recommendations
Recommendations are displayed in two places as you browse:
- Item Detail (Similar items): when an item is focused in the catalogue or search view, the right column shows a list of items the recommender considers similar based on shared tags.
This refreshes as you navigate with
↑/↓. - Order Confirmation (You might also like): after a successful purchase, the confirmation screen lists personalized picks mixing items similar to your recent activity with popular items you have not yet seen.
Use
↑/↓to navigate the list; pressingEnteron a highlighted recommendation resets the session and focuses that product in the catalogue for your next round.
Note
Recommendations are served from precomputed tables that refresh on a configurable interval. Brand-new items or interactions may take up to one refresh cycle to appear in the Similar and You might also like lists.