TGI POS is a point-of-sale application built using Vite, React, Typescript, React Query and TailwindCSS. This project offers a fast and responsive offline sales system designed for businesses that require robust local transaction processing alongside modern frontend technologies.
Note : Performance may be very slow when using this online mode. TGI POS is specifically designed for offline use.
Orders
Manage customer orders efficiently, including order creation, tracking, and payment processing.
Waiters
Track waiter assignments, manage shifts, and monitor service performance to ensure smooth operations.
Tables
Organize table management with real-time availability status, reservations, and table status updates.
Order Items
Handle detailed information for each item in an order, including price, quantity, and customization options.
Menus
Easily update and manage your restaurant's menu, including dish details, pricing, and availability.
Categories
Organize menu items into categories for a streamlined ordering process and easier navigation.
Reports
Generate insightful reports on sales, performance, and inventory to help with data-driven decision making.
Settings
Customize system configurations, including user preferences, restaurant details, and integration setups.
- Integrate with backend headless CMS Integrate with Cockpit headless CMS to handle data management and synchronization.
- POSTMAN API Doc: Create API documentation using Postman.
- Add Authentication: Implement multi-user login system with role-based access.
- Add Reports: Generate sales, inventory, and performance reports.
- Add Refund: Implement refund functionality to handle returns.
- Add Printers and Printing Settings: Enable support for various printers and customize printing configurations.
- Electron: Create cross-platform desktop applications with web technologies.
- Vite: A modern build tool that significantly improves the development experience.
- React: A popular library for building user interfaces.
- React Query: A powerful data-fetching and state management library that simplifies fetching, caching, synchronizing, and updating server state in React applications.
- TailwindCSS: Utility-first CSS framework for rapid styling.
Below is the revised Markdown with improved clarity and grammar:
Note: For the backend API server, ensure you have PHP 8.3+ and SQLite installed on your machine before proceeding.
-
Enter Backend Folder:
cd backend -
Run Backend Server:
php -S localhost:3030
This command starts the Cockpit CMS server.
If you want to modify CMS data, the default credential is
username:admin|password:admin.
-
Enter Frontend Folder:
cd frontend -
Install Dependencies:
npm install
-
Set Up the Environment:
Create a
.envfile in the root folder and add the following variables:VITE_API_URL=http://localhost:3030 VITE_PLACEHOLDER_IMAGE=placeholder.webp VITE_DEMO_SERVER=false VITE_ASSET_URL=http://localhost:3030/storage/uploads
-
Run the Application:
npm run dev
This command starts the Vite development server and launches the POS app.
You can also use docker-compose to run the backend and frontend servers.
docker-compose upWe truly appreciate your interest in contributing to TGI POS! To ensure smooth collaboration, please follow these guidelines:
- Branching and Pull Requests:
- All pull requests must be made to the develop branch.
- Create a new branch from develop for every feature or bugfix you work on.
- Once complete, open a pull request targeting the develop branch.
- Commit Messages:
- Follow the commit message guidelines as described in the Conventional Changelog/commitlint guide.
- Your commit messages should be clear, descriptive, and follow the proper format (e.g., type(scope): description).
- Code Quality and Linting:
- Ensure that your code passes all ESLint checks before submitting a pull request.
- PRs that do not pass ESLint will not be merged until all issues are resolved.
- Run linting locally with the command:
and fix any issues that arise.npm run lint
- General Guidelines:
- Feel free to open an issue to discuss larger changes or new feature ideas before starting work.
- Follow the existing code style and project structure.
- Make sure to update documentation as needed when adding new features or modifying existing ones.
We welcome your contributions and are excited to build a reliable, offline-capable point-of-sale system together!
We welcome contributions! Feel free to check our contributing guidelines and submit issues or pull requests. Special thanks to all contributors who have already supported this project.
If you like TGI Offline POS and want to support our work, please give us a star on GitHub! Your support means a lot and helps us increase the reach of this project.
Donate Us on Buy Me a Coffee
If you find TGI Offline POS helpful, consider supporting the project by buying us a coffee. Your generosity helps us continue to improve and develop new features!
The idea for TGI Offline POS was born out of the need for a reliable, offline-capable point-of-sale system that doesn't rely on constant internet connectivity. We wanted to combine the best of modern web technologies with the stability of a desktop application to create a comprehensive solution for retail and service businesses.
- Thanks to the developers and maintainers of Cockpit CMS, Vite, Typescript, React, React Query, and TailwindCSS for their amazing work.
- Special thanks to the open-source community for continuous support and contributions.
Feel free to open issues, suggest new features, or contribute code. Let's build a powerful offline POS system together!