website logo
Navigate through spaces
⌘K
OVERVIEW
ORDER MANAGEMENT (OMS)
CONTENT MANAGEMENT (CMS)
DATA
CUSTOMER LIFETIME REVENUE
Customer Lifetime Revenue Explanation
Customer Lifetime Revenue and Purchase Likelihood
Recency Frequency and Monetary
CLR and RFM Data Table Glossary
RFM and CLR in the Hub
LOOKER
Modifying a Dashboard
Timestamp differences between Looker, OMS and Shopify
How to create custom calculations in Looker
Looker and Shopify data models
Custom fields
How to 'Save and Schedule' reports
Creating Custom Reports or Look
Looks vs Dashboards
Login Looker FAQ
Looker Glossary
SEGMENT EVENT TRACKING
What are event tracking
Adding Tracking
What is the Tracking Plan?
The Chord Tracking Plan
The Shopify Tracking Plan
Event Tracking FAQ
EVENT UPDATES PAGE
Email Subscription Payment Event Update
Product Feed Setup
Getting Segment to Production
Consent Management
Installing in Next.js
Installing in Gatsby
Integrations
👩‍💻Developer Tools
Using Chord with Shopify
Docs powered by
Archbee
Using Chord with Shopify
...
Developer Tools
Next.js

Quick Start

8min

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

Configure access to Chord's private Github repositories

Share your Github username with the Chord team to gain access to Chord's Github repositories. You'll need to do two things:

  1. Make sure you have access to the starter repository. Reach out to Chord for access with your Github username if you do not.
  2. Configure your local npm to install Chord's packages from GitHub Packages:
  • Go to https://github.com/settings/tokens and click Generate new token. Make sure you select the read:packages scope. Copy the token.
  • If you don't already have one, create a .npmrc file in your home directory (touch ~/.npmrc).
  • Append the following to ~/.npmrc, replacing the <YOUR PERSONAL ACCESS TOKEN> with the Github token you just created:
~/.npmrc
|
//npm.pkg.github.com/:_authToken=<YOUR PERSONAL ACCESS TOKEN>
@chordcommerce:registry=https://npm.pkg.github.com


This means that any npm packages with the @chordcommerce scope will be installed from Github Packages instead of the npm public registry. If you have any trouble on this step, see Github's documentation on configuring npm for use with Github 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:

Shell
|
# with git
git clone git@github.com:<YOUR ACCOUNT>/nextjs-starter-performance.git
# or with the GitHub CLI
gh repo clone <YOUR ACCOUNT>/nextjs-starter-performance


Configure your site's environment

Shell
|
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
npm
|
yarn install


After installation is complete, start the development server:

yarn
npm
|
yarn 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. ✨

Updated 03 Mar 2023
Did this page help you?
PREVIOUS
Next.js
NEXT
Developing
Docs powered by
Archbee
TABLE OF CONTENTS
Configure access to Chord's private Github repositories
Create a new site
Configure your site's environment
Start your development server
Docs powered by
Archbee