VTEX Runner

Tool to perform mass actions using VTEX endpoints.

Report Bug · Request Feature

Features

• Automates mass actions on VTEX (using VTEX endpoints)
• Manage workspace: installing, uninstalling, creation, and deletion
• Dockerized application
• Spreadsheet reading logic, facilitating data reception from a mkt team

Important

This project requires Node.js 16 or higher and npm. $ npm -v && node -v

How to use

Run it on a GitHub Codespaces

• To run the project on codespaces follow the instructions bellow:

1. Create codespace on main

   • Wait for codespace to identify the Node.js version and run npm i automatically

2. Start the server:

   npm run dev
   

3. Rename the file .env.example to .env and update environment variables with yours values.

4. Check routes in /docs and and the example of expected spreadsheets in assets/spreadsheets/example and after filling them out, pass them to asseets/spreadsheets/app

Run it locally,

• To download the project follow the instructions bellow:

1. Clone the repo

   git clone https://github.com/zmatezz/vtex-runner
   

   cd vtex-runner
   

2. Install the dependencies and start the server:

   npm i
   

   npm run dev
   

   or

   yarn install
   

   yarn dev
   

3. Rename the file .env.example to .env and update environment variables with yours values.

4. Check routes docs and the example of expected spreadsheets in assets/spreadsheets/example and after filling them out, pass them to asseets/spreadsheets/app

   or

• I recommend use Docker to run the project, but it's your preference, to do this

1. To run the project with Docker, perform all the previous steps, except 2 and, execute the command:

   docker-compose up --build
   

Contributing

You can contribute to the project in several different ways:

• Creating a fork of the project and sending PR with new features or bug fixes
• Requesting new features for the application
• Reporting Bugs or improvements to the project

License

This project is licensed under Creative Commons Attribution-NonCommercial (CC BY-NC). You are free to use it, as long as it is for non-commercial purposes and credit is given to the creator.

made by zmatezz