README
¶
Nutrix is a point of sale management system. It allows you to manage inventory, sales and products for your restaurant or shop.
You need to integrate with a GUI service to provide an interface for end users, you can find the standard GUI in the frontend dir, it's a vuejs app, you can build it and put the content of the dist into /mnt/frontend
Currently nutrix supports only restaurant style cycle, where the order is sent first to the kitchen awaiting to be started then begin processing the inventory.
OpenAPI 3.x Docs :
modules/core/specs.api.yaml
You can use the openapi docs to run Swagger docs and test the api and you can also use the docs with a mock server like Prism to develop the frontend without the need of installing nutrix.
Check the Getting started guide for installation guide and docs.
Documentation
¶
Overview ¶
Package main is the entrypoint for the nutrix application.
It sets up the config, logger, and userio, and then starts the main server.
The main server is a gorilla/mux router that hosts the core, auth, and other modules.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cmd handles the command-line interface and operations for the application.
|
Package cmd handles the command-line interface and operations for the application. |
|
common
|
|
|
config
Package config implements the config interface for the viper config backend.
|
Package config implements the config interface for the viper config backend. |
|
customerrors
Package customerrors contains custom error types and values.
|
Package customerrors contains custom error types and values. |
|
logger
Package logger implements a logger that uses the zap library.
|
Package logger implements a logger that uses the zap library. |
|
userio
Package userio provides an interface for user interaction prompts, and a bubbletea implementation of such an interface.
|
Package userio provides an interface for user interaction prompts, and a bubbletea implementation of such an interface. |
|
Package modules is the package for managing the modules of the application.
|
Package modules is the package for managing the modules of the application. |
|
auth
Package auth contains the authentication module which is responsible for authenticating and authorizing users on the endpoints.
|
Package auth contains the authentication module which is responsible for authenticating and authorizing users on the endpoints. |
|
auth/middlewares
Package middlewares provides a set of middleware functions used to check Zitadel access token for auth and roles.
|
Package middlewares provides a set of middleware functions used to check Zitadel access token for auth and roles. |
|
core
Package core contains the core module of the nutrix application.
|
Package core contains the core module of the nutrix application. |
|
core/dto
Package dto contains structs for data transfer objects (DTOs) used in the core module of nutrix.
|
Package dto contains structs for data transfer objects (DTOs) used in the core module of nutrix. |
|
core/handlers
Package handlers contains HTTP handlers for the core module of nutrix.
|
Package handlers contains HTTP handlers for the core module of nutrix. |
|
core/middlewares
Package middlewares contains middleware functions for the web server.
|
Package middlewares contains middleware functions for the web server. |
|
core/models
Package models contains the data models for the application.
|
Package models contains the data models for the application. |
|
core/services
Package services contains the business logic of the core module of nutrix.
|
Package services contains the business logic of the core module of nutrix. |