/unopim

A free and open-source Laravel-based PIM system to help businesses organize, manage, and enrich their product data centrally.

Primary LanguagePHPOpen Software License 3.0OSL-3.0

UnoPim logo

UnoPim is an open-source Product Information Management (PIM) system built on the Laravel framework. It helps businesses organize, manage, and enrich their product information in one central repository.

🛠️ System Requirements

Ensure your server meets the following requirements:

  • Server: Apache 2
  • RAM: 8GB
  • Node.js: 18.17.1 LTS or higher
  • PHP: 8.2 or higher
  • Composer: 2.5 or higher
  • MySQL: Version 8.0.32 or higher

✨ Features

  • Centralized Product Management
    Manage all your product data in one place.

    Centralized Product Management Interface

  • Data Enrichment
    Enhance your product information with detailed attributes and descriptions.

    Data Enrichment Interface

  • Magic AI for Product Content Generation
    Automatically generate engaging product content using advanced Large Language Model (LLM) technology.

    AI-powered Product Content Generation

  • User Management
    Control user access and permissions.

    User Management Interface

  • API Integration
    Seamlessly integrate with other systems via RESTful APIs.

    API Integration Interface

  • Localization
    Support for multiple languages and locales.

    Localization Support

  • Multi-Channel
    Support for multiple sales channels.

    Multi-Channel Support

  • Multi-Currency
    Support for multiple currencies.

    Multi-Currency Support

  • Import/Export Functionality
    Easily import and export product data using CSV and XLSX formats, with a quick export feature for streamlined data handling.

    Data Import/Export Interface

  • Themes
    UI compatible with both Light and Dark themes.

    Light/Dark Theme Interface

  • Version Control
    Track the history of changes in your product data.

    Version Control Interface

🚀 Installation

To get started with UnoPim, follow these steps:

  1. Project Setup:

    composer create-project unopim/unopim
    cd unopim
  2. Install UnoPim:

    php artisan unopim:install
  3. Serve the application:

    php artisan serve
  4. Access UnoPim:
    Open your browser and go to http://localhost:8000.

  5. Queue Operations:
    To execute import/export operations, initiate the Queue command:

    php artisan queue:work

🐳 Installation with Docker

If you have Docker/Docker Compose installed, follow these steps:

  1. Clone the repository:

    • HTTPS: git clone https://github.com/unopim/unopim.git
    • SSH: git clone git@github.com:unopim/unopim.git
  2. Enter the directory:

    cd unopim
  3. Start the Docker containers:

    docker-compose up -d

    This will pull the necessary images and set up the environment. Once running, access the application at:

    • Application: http://localhost:8000
    • MySQL: http://localhost:3306

Note:
If MySQL is already running on your system, change the MySQL port in the docker-compose.yml and .env files.
Run docker-compose up -d again to apply changes.

📖 Usage

Once installed, you can start adding and managing your products. The intuitive interface allows you to categorize products, enrich data, and manage user permissions easily.

📬 Postman API Collection

To interact with UnoPim's API, you can use our official Postman collection:

UnoPim APIs on Postman

This collection provides ready-to-use API requests for various UnoPim features. You can import it directly into your Postman workspace and start testing the APIs.

🤝 Contributing

We welcome contributions! To contribute:

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

🔒 Security

If you discover any security vulnerabilities, please follow our Security Policy and report them to support@webkul.com.

📝 License

UnoPim is open-source software licensed under the Open Software License (OSL) 3.0.

🙏 Acknowledgements

We extend our thanks to all contributors and the Laravel community for their support and contributions.