Quick Start

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 make sure you have access to the https //github com/chordcommerce/nextjs starter performance mailto\ help\@chord co with your github username if you do not 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 https //docs github com/en/free pro team\@latest/packages/using github packages with your projects ecosystem/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 \# 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 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 yarn install npm npm install after installation is complete, start the development server yarn yarn dev # starts site at http //localhost 3000 npm 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 ✨