Skip to content

README.md

Latest commit

 

History

History
131 lines (92 loc) · 3.54 KB

README.md

File metadata and controls

131 lines (92 loc) · 3.54 KB
BentaKo! Logo

BentaKo! - Modern Point of Sale System

License: MIT React TypeScript Vite React Query

A modern, responsive point-of-sale (POS) system built with React, TypeScript, and Vite. BentaKo! helps small businesses manage sales, inventory, and transactions with ease.

📱 Screenshots

Dashboard Inventory Management
Dashboard View Inventory Management
Reports Debts Management
Reports View Utang List

✨ Features

🛍️ Sales & Checkout

  • Intuitive product catalog with search and filtering
  • Quick add to cart with quantity controls
  • Real-time cart management

📦 Inventory Management

  • Real-time inventory tracking
  • Low stock alerts
  • Product categories and variants

📊 Reporting

  • Sales reports (daily, weekly, monthly)
  • Product performance tracking
  • Revenue overview

💳 Customer Management

  • Purchase history
  • Credit tracking (Utang system)

🎨 Modern UI/UX

  • Responsive design (desktop & mobile)
  • Dark/Light theme support
  • Keyboard shortcuts
  • Intuitive navigation
  • Accessible interface

🚀 Getting Started

Prerequisites

  • Node.js 18+
  • Bun (v1.1.10)
  • Git

Installation

  1. Clone the repository:

    git clone https://github.com/Ravsalt/BentaKo.git
cd BentaKo

  2. Install dependencies:

    bun install

  3. Start the development server:

    bun run dev

  4. Open http://localhost:5173 in your browser.

🛠️ Tech Stack

  • Core: React 19, TypeScript, Vite
  • State: React Query
  • Styling: Styled Components
  • Icons: Lucide Icons
  • Routing: React Router
  • Animations: Framer Motion

📦 Production Build

To create a production build:

bun run build

The build artifacts will be stored in the dist/ directory.

🧪 Testing

Run the test suite:

bun run test

🤝 Contributing

Contributions are welcome! Please follow these steps:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

  • Built with ❤️ for small business owners
  • Inspired by the need for simple, effective POS solutions
  • Special thanks to all contributors and open-source maintainers /

📬 Contact

Have questions or suggestions? Feel free to open an issue or reach out to the maintainers.