Quick Start

5 min

This guide assumes you already have Node.js and Git installed on your machine.

Configure access to Chord's private Github repositories

In order to install the necessary Chord packages, follow the guide below on how to configure your package manager to access Chord's packages.

npm Access for @chordcommerce Packages

Create a new site

Click the "Use this template" button on the starter Github repository to create a new Github repository in your account with the same files and folders, or fork the repo. Then clone your new repo onto your local machine:

# with git
git clone [email protected]:<YOUR ACCOUNT>/nextjs-starter-autonomy.git
# or with the GitHub CLI
gh repo clone <YOUR ACCOUNT>/nextjs-starter-autonomy

Configure your site's environment

cp .env.example .env

You'll need to populate this .env file with some environment variables, including your Chord account and CMS credentials. Talk to the Chord team to get these.

Start your development server

Install project dependencies:

yarn install

After installation is complete, start the development server:

npm run dev     # starts site at http://localhost:3000

You can see your new site at http://localhost:3000. Hot reload is enabled by default.

That's it! You're off and running. ✨