hypertuner-cloud/DEVELOPMENT.md

Development guide

This guide will help you set up this project.

Requirements

• Node Version Manager: nvm

Setup local environment variables

cp .env .env.local

Authenticate to GitHub Packages

Project uses shared packages (@hyper-tuner/...).

They are hosted using GitHub Packages, to install them you need to authenticate to GitHub Packages first.

Personal access token

Generate GitHub Personal access token.

Private token can be assign to ENV when running npm install in the same shell:

export NPM_GITHUB_TOKEN=YOUR_PRIVATE_GITHUB_TOKEN

Setup correct Node.js version

nvm use

Install dependencies and run in development mode

# install packages
npm install

# run development server
npm start