BigC Mimic CLI

BigC Mimic CLI is a command line interface using ChatGPT to intelligently retrieve data from eCommerce sites and transfer data to BigCommerce storefronts. Currently it's primary use is for the Solutions Engineering team at BigCommerce to ease POC development.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

(back to top)

Built With

• 
• 
• 
• 

(back to top)

Getting Started

Here's how to get started...

Prerequisites

Developed on Node v18.15.0. Need to further test compatibilities with node versions.

Installation

1. Get a Chat GPT API Key at https://platform.openai.com/docs/guides/gpt
2. Choose a storefront and create an API Key with the following scopes:
   • Create Product
   • Create Categories
   • Create Channel Assignments
3. Clone the repo and cd into the bigc-mimic folder

   git clone https://github.com/glynnsanity/bigc-mimic.git
   
   cd bigc-mimic

4. Install packages

   npm install -g

5. Initiate BigC Mimic config (follow prompts)

   bigc-mimic init

6. Run a category scan to retrieve product data (follow prompts)

   bigc-mimic catscan

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Add SKU and Stock number generation
• Experiment with single product page analysis for complex products (bigc-mimic prodscan)
• Improve CLI experience

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

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

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

(back to top)

Contact

Glynn Jordan - LinkedIn - glynn.jordan@bigcommerce.com

Project Link: https://github.com/glynnsanity/bigc-mimic

(back to top)

Acknowledgments

(back to top)