Uniform commerce starter for BigCommerce and Next.js

This is a Next.js project bootstrapped with create-next-app.

Getting Started

1. Create a new project on uniform.app
2. Create API key with permissions to modify Canvas.
3. Add your uniform api keys to .env
4. Install packages by running npm install

Push artifacts if you create a project from scratch [skip the following two steps if the project was created via onboarding - all artifacts are already pushed in this case]:

1. Run this to push all components and compositions from disk into your project: npm run push

2. Run this to push signals and enrichments from disk into your project: push:context:signals push:context:enrichments

3. Run the development server: npm run dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.js. The page auto-updates as you edit the file.

API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.js.

The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

Learn More

To learn more about Next.js, take a look at the following resources:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.