DEVELOPMENT.md

Development guide

This guide will help you set up this project.

Requirements

• Node 16.x.x (Node Version Manager: nvm)
• Firebase
  • Authentication
  • Storage
  • Firestore Database
• Firebase CLI
• Google Cloud SDK (brew install --cask google-cloud-sdk)

Setup local environment variables

cp .env .env.local

Authenticate to GitHub Packages

Project uses shared packages (@speedy-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

Install dependencies and run in development mode

# install packages
npm install

# run development server
npm start

Firebase

Storage

Authenticate:

gcloud auth login

Set up CORS:

gsutil cors set firebase/cors.json gs://<YOUR-BUCKET>