# shopify-mock-products

> This Node.js application generates a CSV file with mock product data for Shopify stores. It allows you to create a specified number of products within a given category and includes product images fetched from the Pexels API.

Latest version **1.0.0** (published 2023-03-18) · ISC license · 0 weekly downloads

## Install

```sh
npm install shopify-mock-products
pnpm add shopify-mock-products
yarn add shopify-mock-products
bun add shopify-mock-products
```

Provides the command `products`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2023-03-18 |
| First published | 2023-03-18 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 7.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Michael Nunez |
| Maintainers | newnez |

## Links

- npm: https://www.npmjs.com/package/shopify-mock-products
- npm.io page: https://npm.io/package/shopify-mock-products

## Dependencies (5)

- [axios](https://npm.io/package/axios.md) ^1.3.4
- [faker](https://npm.io/package/faker.md) ^5.5.3
- [dotenv](https://npm.io/package/dotenv.md) ^16.0.3
- [datamuse](https://npm.io/package/datamuse.md) ^1.0.5
- [csv-writer](https://npm.io/package/csv-writer.md) ^1.6.0

## Recent versions

- 1.0.0 (latest) — 2023-03-18

## README

# Shopify Mock Products Generator

This Node.js application generates a CSV file with mock product data for Shopify stores. It allows you to create a specified number of products within a given category and includes product images fetched from the Pexels API.

## Features

- Generates mock product data based on a specified category
- Includes product images from the Pexels API
- Exports data to a Shopify-compatible CSV file

## Prerequisites

- Node.js (version 14 or later recommended)
- NPM (Node Package Manager)
- Pexels API key

## Installation

1. Clone the repository:

```bash
git clone https://github.com/yourusername/shopify-mock-products.git
```

2. Change the current directory to the project folder:

```bash
cd shopify-mock-products
```

3. Install the required dependencies:

```bash
npm install
```

4. Set up the environment variables:
Create a **.env** file in the project's root directory and add your Pexels API key:

```makefile
PEXELS_API_KEY=your_pexels_api_key_here
```

Replace **your_pexels_api_key_here** with your actual Pexels API key.

## Usage

To generate mock products, run the following command:

```bash
node app.js "Category" NumberOfProducts
```

Replace **Category** with the desired product category (e.g., "Electronics") and **NumberOfProducts** with the number of products you want to generate (e.g., 10).

Example:

```bash
node app.js "Electronics" 10
```

This command will generate a CSV file named **shopify_products.csv** containing 10 mock electronic products.

## NOTE / TODO
- The amount argument is a maximum, but you will most likely get less, because ones w/o images are discarded
- Main improvement would be to have higher quality images, currently using Pexels, but considering other options
  including adding better keywords for filtering
- You can request any amount you want; however, over 100 at once, there may be errors


## Contributing
Contributions are welcome! If you'd like to contribute, please create a fork of this repository, make your changes, and submit a pull request. If you have any questions or need assistance, feel free to open an issue.

## License
This project is licensed under the MIT License. For more information, see the **LICENSE** file.

---
_Source: https://npm.io/package/shopify-mock-products · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._