The Store Design microapp allows users to customize the appearance and content of their storefront.
The build process of this application is handled by create-react-app, using our custom bc-react-scripts.
Our version of bc-react-scripts uses a new npm run dev command to "transpile" the final build into the bigcommerce/vendor/bower_components/store-design directory when building locally.
Run the following commands to get started:
npm install
To start development npm run dev
To start testing npm test
To run eslint npm run eslint
To run eslint with --fix enabled npm run eslint -- --fix
If you are running cloud-dev-vm and want to run this app, one option is to do the above while ssh'd into your vm. There is also work being done to support the traditional npm run start functionality from create-react-app, including hot reloading.
All code changes except for creating new releases should be reviewed and accepted by at least one reviewer. When you create a new pull request @mention the specific software engineers you'd like to review your code.
The application is built using React and Typescript. Some notable libraries include:
- React Router is used for managing client-side routing.
- Redux is used for managing application state.
- Styled Components is used for styling components.
- BigCommerce Pattern Lab is used for building a consistent BigCommerce Control Panel UI.
