This article serves as a guide to getting the BigCommerce connector set up for local development.

1 - Basics

1. Fork and clone the connector-bigcommerce repository on your machine
2. Navigate to the project directory in your console and run:  bundle install
3. Be sure to set up your database by running:  rake db:setup 

2 - Environment Variables

Before starting the connector, the environment variables must be set:

2.1 - application.yml

From your console run:  cp config/application.sample.yml config/application.yml

Your application.yml file should look like this:

encryption_key1:
encryption_key2:

bc_client_id:
bc_client_secret:

SIDEKIQ_USERNAME: admin
SIDEKIQ_PASSWORD: password

REDIS_URL: redis://localhost:6379/0/connector-bigcommerce

MNO_DEVPL_HOST: https://dev-platform.maestrano.com
MNO_DEVPL_API_PATH: /api/config/v1/marketplaces
MNO_DEVPL_ENV_NAME: bigcommerce-nex
MNO_DEVPL_ENV_KEY:
MNO_DEVPL_ENV_SECRET:

2.1.1 - Encryption Keys

These can be set to anything. Just be sure to set them as they are required for the connector to run.

2.1.2 - BC Client Variables

The bc_client_id and bc_client_secret should be set to the client_id and client_secret from your BigCommerce API account:

1. Sign up for an account at https://www.bigcommerce.com/ (You can just use a free trial account)
2. Once you have created your account, sign-in to your BigCommerce dashboard
3. From the dashboard you will need to go to:  Advanced Settings → API Accounts
4. Create an API account. On creation, you will be provided with credentials for your new API account. These include your Client ID, Client Secret, and Access Token. (be sure to save these as they cannot be retrieved again later)