HAL-9001

Your AI-Powered Bar Cart Management System
Explore the docs »

Report Bug · Request Feature

About The Project

HAL-9001 is a cutting-edge system that revolutionizes how you manage your spirits collection. By combining advanced imaging technology with AI-powered analysis, it offers an intelligent solution for cataloging and organizing your bar cart.

Key Features

• 📸 Smart Image Recognition: Capture bottle images with high-resolution camera integration
• 🤖 AI-Powered Analysis: Leverages OpenAI's ChatGPT for intelligent data extraction
• 📊 Comprehensive Data Collection: Automatically extracts:
  • Brand and model information
  • Alcohol by volume (ABV)
  • Suggested retail price
  • Bottle details and characteristics
• 📱 Modern User Interface: Built with React for a seamless user experience
• 🔄 Real-time Processing: Efficient Node.js backend for quick data processing

Built With

• - Frontend framework
• - Backend runtime
• OpenAI ChatGPT - AI analysis
• High-resolution imaging system

Getting Started

Follow these steps to set up HAL-9001 locally.

Prerequisites

• Node.js (v14 or higher)
• npm

  npm install npm@latest -g
• A compatible camera system
• OpenAI API key

Installation

1. Clone the repository

   git clone https://github.com/pjmarz/HAL-9001.git
2. Install NPM packages

   cd HAL-9001
   npm install
3. Configure your environment variables

   cp .env.example .env
4. Enter your API keys in .env

   OPENAI_API_KEY=your_api_key_here
   

Usage

1. Start the application

   npm start
2. Open your browser and navigate to http://localhost:3000
3. Follow the on-screen instructions to:
   • Set up your camera
   • Capture bottle images
   • View and manage your collection

Design

Check out our Figma Design to see the UI/UX planning and design system.

Roadmap

• Multi-bottle scanning
• Mobile app development
• Cocktail recipe recommendations
• Inventory tracking system
• Social sharing features

See the open issues for a full list of proposed features and known issues.

Contributing

Contributions make the open source community an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your 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

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Peter Marino - @pjmarz - [email protected]

Project Link: https://github.com/pjmarz/HAL-9001